text sherlock

テキストシャーロック（またはシャーロック）

テキストには、高速で簡単にインストールしやすく、検索エンジンを使用できるが、ソースコード用に最適化されています。代替手段であるOpenGrokは、インストールするのに時間がかかりすぎる必要があります（一部の人にとっては価値があるかもしれませんが）が、より豊富です。 Text Sherlockは、はるかに簡単なセットアップ、テキストインデックス、、ほとんど努力を払わずに検索するためのWebアプリインターフェイスを提供します。

ソリ・デオ・グロリア

基本セットアップ

説明書：

1. GithubからSherlockソースをダウンロードしてください。
2. Sherlockソースコードを目的の（インストール）ディレクトリに抽出/配置します。これはシャーロックが住んでいる場所になります。
3. sh setup/virtualenv-setup.shを実行して、分離環境をセットアップし、コアパッケージをダウンロードします。
4. 設定を構成します。 settings.pyのデフォルトは、各設定のドキュメントを提供します。
   • example.local_settings.ymlをlocal_settings.ymlにコピーします。
   • settings.pyからlocal_settings.ymlに任意の設定をオーバーライド/コピーします（必要に応じて値を変更します）。すべてのYAMLキー/オプションは小文字でなければなりません。
5. source sherlock_env/bin/activateを実行して、仮想環境に入ります。
6. python main.py --index updateまたは--index rebuildして、設定で指定されたパスをインデックス化します。インデックス作成出力をご覧ください。
7. python main.py --runserverを実行して、Webサーバーを起動します。
8. http://localhost:7777にアクセスして、Webインターフェイスにアクセスします。 UIにブートストラップツールキットを使用します。

Ubuntuのインストールがエラーなしで実行される前に、いくつかのパッケージをインストールする必要がある場合があります。

• カールのインストール： sudo apt-get install curl
• uuid libsをインストール： sudo apt-get install uuid-dev
• Python Dev： sudo apt-get install python-dev

---

含まれる：

• 設定/構成
  • 詳細については、 settings.py参照してください。
• セットアップスクリプト（詳細については、スクリプトの内容を読む）
  • virtualenv-setup.shを実行して、孤立したインストールを実行します。
• メインコントローラースクリプト
  • 詳細については、 main.py -hを実行します。
• エンドツーエンドインターフェイス
  • テキストのインデックス作成と検索（ソースコード）。 Hoosh（高速検索）またはXapian（はるかに速い検索）の組み込みサポート。
    • カスタムバックエンドを介してインデックスまたは検索を簡単に拡張できます。
  • WerkzeugまたはCherootを使用して提供されるフロントエンドWebアプリ。
    • werkzeugは、少量のトラフィックへの開発のためです。
    • cheroot 、Cherrypyが使用する高性能のPure-Python HTTPサーバーです。
  • Pythonを使用した設定と構成。

Webインターフェイス

特徴：

ドキュメントURLに追加します。

• ラインを強調表示するには、urlに追加されます。 &hl=3,7,12-14,21
• 行にジャンプするには、urlの終了に追加します： #line-3

他のバックエンドを使用します

settings.py ：

• default_indexerとdefault_searcher値を変更して、バックエンドに与えられた名前と一致します。
  • 考えられる値：
    • デフォルトwhoosh 、追加の作業は必要ありません。
    • xapian 、含まれているsetup/install-xapian.shセットアップスクリプトを使用して個別にインストールする必要があります。

他のWebサーバーを使用します

Text Sherlockには、WerkzeugとCheroot WSGIに準拠したサーバーのサポートが組み込まれています。

settings.py ：

• server_type値を使用可能なサーバータイプのいずれかに変更します。
  • 考えられる値：
    • default 、werkzeug webサーバー（デフォルト）。
    • cheroot 、生産対応のWebサーバー。

コアパッケージ

Python 3.5+が必要です

• おっと
• フラスコ
• jinja2
• pygments
• ピューイ
• ブートストラップv4.x
• pyyaml

その他の参照

• https://pygments.org/
• http://docs.peewee-orm.com/
• https://cheroot.cherrypy.org/
• https://xapian.org/
• https://pyyaml.org/wiki/pyyamldocumentation
• https://zeptojs.com

プロジェクトの目標

1. セットアップが簡単で、高速で適切なテキスト検索エンジンソリューションを提供します。
2. OpenGrokの立派な代替手段になりましょう。
3. OpenGrokの貢献者に影響を与えて、よりシンプルなセットアッププロセスを提供します。
   • CentosとUbuntu 11.xにOpenGrokの2つのインストールを正常にセットアップしました。毎回2時間以上かかりました。テキストシャーロックのセットアップには5分もかかりません（パッケージのダウンロード時間を除く）。

貢献者

• クリストファー・ベス
• ラファエル・ボイドル
• そして他の...