text sherlock

Text Sherlock (oder Sherlock)

Bietet eine schnelle, einfach zu installierende und einfach zu verwendende Suchmaschine für Text, ist jedoch für den Quellcode optimiert. Eine alternative, OpenGrok erfordert zu viel Zeit, um die Installation zu installieren (obwohl es sich für manche möglicherweise lohnt), ist jedoch mehr Funktionen. Text Sherlock bietet Ihnen ein viel einfacheres Setup, einen Textindexer und eine Web -App -Oberfläche für die Suche mit sehr wenig Aufwand.

Soli Deo Gloria

Basic Setup

Anweisungen:

1. Laden Sie Sherlock Source von GitHub herunter.
2. Extrahieren/platzieren Sie den Sherlock -Quellcode in das gewünschte Verzeichnis (Installation). Hier lebt Sherlock.
3. Führen Sie sh setup/virtualenv-setup.sh aus, um eine isolierte Umgebung einzurichten und Kernpakete herunterzuladen.
4. Einstellungen konfigurieren. Die Standardeinstellungen in settings.py enthalten Dokumentation für jede Einstellung.
   • Kopieren Sie example.local_settings.yml zu local_settings.yml .
   • Überschreiben/kopieren Sie jede Einstellung von settings.py zu local_settings.yml (ändern Sie die Werte nach Bedarf). Alle YAML -Schlüsseln/Optionen müssen Kleinbuchstaben sein.
5. Führen Sie source sherlock_env/bin/activate um die virtuelle Umgebung einzugeben.
6. Führen Sie python main.py --index update oder --index rebuild um den in den Einstellungen angegebenen Pfad zu indizieren. Beobachten Sie die Indexierungsausgabe.
7. Führen Sie python main.py --runserver aus, um den Webserver zu starten.
8. Gehen Sie zu http://localhost:7777 um auf die Weboberfläche zuzugreifen. Verwendet das Bootstrap -Toolkit für die Benutzeroberfläche.

Möglicherweise müssen Sie einige Pakete installieren, bevor eine Ubuntu -Installation ohne Fehler ausgeführt wird.

• sudo apt-get install curl
• Installieren Sie UUID Libs: sudo apt-get install uuid-dev
• Installieren Sie Python Dev: sudo apt-get install python-dev

---

Beinhaltet:

• Einstellungen/Konfiguration
  • Einzelheiten siehe settings.py .
• Setup -Skript einrichten (Inhalt des Skripts lesen, um weitere Informationen zu erhalten)
  • Führen Sie virtualenv-setup.sh aus, um eine isolierte Installation durchzuführen.
• Hauptcontroller -Skript
  • Führen Sie main.py -h für weitere Informationen aus.
• End-to-End-Schnittstelle
  • Indexierung und Suchtext (Quellcode). Eingebaute Unterstützung für Whoosh (schnelles Suchen) oder Xapian (viel schnelleres Suchen).
    • Leichte Indizierung oder Suche über benutzerdefinierte Backends zu erweitern.
  • Frontend -Web -App, die mit Werkzug oder Cheroot serviert wird.
    • werkzeug ist für die Entwicklung des kleinen Verkehrs.
    • cheroot ist der Hochleistungs-HTTP-Server mit reinem Python, der von CherryPy verwendet wird.
  • Einstellungen und Konfiguration mit Python.

Webschnittstelle

Merkmale:

Anhängen, um URL zu dokumentieren.

• Um Linien hervorzuheben, anhängen an URL: &hl=3,7,12-14,21
• Um in eine Zeile zu springen, anhängen an das Ende von URL: #line-3

Andere Backends verwenden

In settings.py :

• Ändern Sie die Werte default_indexer und default_searcher so, dass sie dem dem Backend gegebenen Namen übereinstimmen.
  • Mögliche Werte:
    • whoosh DER DEFALLT, keine zusätzliche Arbeit erforderlich.
    • xapian muss separat mit dem mitgelieferten setup/install-xapian.sh -Setup-Skript installiert werden.

Verwenden anderer Webserver

Text Sherlock hat integrierte Unterstützung für Werkzug und Cheroot WSGI-konforme Server.

In settings.py :

• Ändern Sie den Wert server_type in einen der verfügbaren Servertypen.
  • Mögliche Werte:
    • default , Werkzug Web Server (Standard).
    • cheroot , Produktionsbereit -Webserver.

Kernpakete

Benötigt Python 3.5+

• Rauschen
• Flasche
• Jinja2
• Pygmente
• Peewee
• Bootstrap v4.x
• Pyyaml

Andere Referenzen

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

Projektziele

1. Stellen Sie eine einfach zu erstellende, schnelle und angemessene Text -Suchmaschinenlösung an.
2. Eine respektable Alternative zu OpenGrok sein.
3. Beeinflussen Sie die OpenGrok -Mitwirkenden, um einen einfacheren Setup -Prozess bereitzustellen.
   • Ich habe zwei Installationen von OpenGrok auf CentOS und Ubuntu 11.X erfolgreich eingerichtet. Jedes Mal dauerte es mehr als zwei Stunden . Text Sherlock Setup dauert weniger als 5 Minuten (ohne Paket -Download -Zeit).

Mitwirkende

• Christopher Bess
• Raphael Boidol
• Und andere ...