text sherlock

Texto Sherlock (o Sherlock)

Proporciona un motor de búsqueda rápido, fácil de instalar y simple de usar para el texto, pero optimizado para el código fuente. Una alternativa, OpenGrok, requiere demasiado tiempo para instalar (aunque puede valer la pena para algunos), pero es más rico en características. Text Sherlock le dará una configuración mucho más fácil, un indexador de texto y una interfaz de aplicación web para buscar con muy poco esfuerzo.

Soli deo Gloria

Configuración básica

Instrucciones:

1. Descargue Sherlock Source de GitHub.
2. Extraer/colocar el código fuente de Sherlock en el directorio deseado (Instalar). Aquí será donde vive Sherlock.
3. Ejecute sh setup/virtualenv-setup.sh para configurar un entorno aislado y descargar paquetes principales.
4. Configurar configuraciones. Los valores predeterminados en settings.py proporcionan documentación para cada configuración.
   • Copiar example.local_settings.yml a local_settings.yml .
   • Anular/Copiar cualquier configuración de settings.py a local_settings.yml (cambie los valores según sea necesario). Todas las teclas/opciones YAML deben ser en minúsculas.
5. Ejecute source sherlock_env/bin/activate para ingresar al entorno virtual.
6. Ejecute python main.py --index update o --index rebuild para indexar la ruta especificada en la configuración. Mira la salida de indexación.
7. Ejecute python main.py --runserver para iniciar el servidor web.
8. Vaya a http://localhost:7777 para acceder a la interfaz web. Utiliza el kit de herramientas Bootstrap para su interfaz de usuario.

Es posible que deba instalar algunos paquetes antes de que una instalación de Ubuntu se ejecute sin error.

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

---

Incluye:

• Configuración/configuración
  • Consulte settings.py para más detalles.
• Script de configuración (leer contenido del script para obtener más información)
  • Ejecute virtualenv-setup.sh para realizar una instalación aislada.
• Script del controlador principal
  • Ejecute main.py -h para obtener más información.
• Interfaz de extremo a extremo
  • Indexación y búsqueda de texto (código fuente). Soporte incorporado para Whoosh (búsqueda rápida) o Xapian (búsqueda mucho más rápida).
    • Extienda fácilmente la indexación o la búsqueda a través de backends personalizados.
  • La aplicación web front -end servida con Werkzeug o Cheroot.
    • werkzeug es para el desarrollo de un pequeño tráfico.
    • cheroot es el servidor HTTP de alto rendimiento, Pure-Python utilizado por Cherrypy.
  • Configuración y configuración utilizando Python.

Interfaz web

Características:

Agregar para documentar URL.

• Para resaltar las líneas, agregar a URL: &hl=3,7,12-14,21
• Para saltar a una línea, agregue al final de la URL: #line-3

Usando otros backends

En settings.py :

• Cambie los valores de default_indexer y default_searcher para que coincidan con el nombre dado al backend.
  • Valores posibles:
    • whoosh el valor predeterminado, no se necesita trabajo adicional.
    • xapian debe instalarse por separado utilizando el script de configuración de setup/install-xapian.sh .

Usando otros servidores web

Text Sherlock tiene soporte incorporado para los servidores compatibles con Werkzeug y Cheroot WSGI.

En settings.py :

• Cambie el valor server_type a uno de los tipos de servidor disponibles.
  • Valores posibles:
    • default , servidor web Werkzeug (predeterminado).
    • cheroot , servidor web de producción lista.

Paquetes centrales

Requiere Python 3.5+

• Homicidio
• Matraz
• Jinja2
• Pigmentos
• peewee
• Bootstrap v4.x
• Pyyaml

Otras referencias

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

Proyecto de objetivos

1. Proporcione una solución de motor de búsqueda de texto fácil de configurar, rápida y adecuada.
2. Sea una alternativa respetable a OpenGrok.
3. Influir en los contribuyentes de OpenGrok para proporcionar un proceso de configuración más simple.
   • Configuré con éxito dos instalaciones de OpenGrok en Centos y Ubuntu 11.x. Cada vez tomó más de dos horas . La configuración de Text Sherlock lleva menos de 5 minutos (excluyendo el tiempo de descarga del paquete).

Colaboradores

• Christopher Bess
• Raphael Boidol
• Y otros ...