text sherlock

Texto Sherlock (ou Sherlock)

Fornece um mecanismo de pesquisa rápido, fácil de instalar e simples de usar, mas otimizado para o código -fonte. Uma alternativa, OpenGrok, requer muito tempo para instalar (embora possa valer a pena para alguns), mas é mais rico em recursos. O texto Sherlock fornecerá uma configuração muito mais fácil, um indexador de texto e uma interface do aplicativo da web para pesquisar com muito pouco esforço.

Soli Deo Gloria

Configuração básica

Instruções:

1. Faça o download da fonte Sherlock do Github.
2. Extraia/coloque o código -fonte Sherlock no diretório desejado (instalar). É aqui que Sherlock mora.
3. Run sh setup/virtualenv-setup.sh para configurar um ambiente isolado e baixar pacotes principais.
4. Definir configurações. Os padrões em settings.py fornecem documentação para cada configuração.
   • Cópia example.local_settings.yml para local_settings.yml .
   • Substitua/copie qualquer configuração do settings.py para local_settings.yml (altere os valores conforme necessário). Todas as teclas/opções YAML devem ser minúsculas.
5. Execute source sherlock_env/bin/activate para entrar no ambiente virtual.
6. Execute python main.py --index update ou --index rebuild para indexar o caminho especificado nas configurações. Observe a saída de indexação.
7. Execute python main.py --runserver para iniciar o servidor da Web.
8. Vá para http://localhost:7777 para acessar a interface da web. Usa o kit de ferramentas de bootstrap para a interface do usuário.

Pode ser necessário instalar alguns pacotes antes que uma instalação do Ubuntu seja executada sem erro.

• Instale Curl: sudo apt-get install curl
• Instale Libs Uuid: sudo apt-get install uuid-dev
• Instale o Python Dev: sudo apt-get install python-dev

---

Inclui:

• Configurações/configuração
  • Consulte settings.py para obter detalhes.
• Script de configuração (Leia o conteúdo do script para obter mais informações)
  • Execute virtualenv-setup.sh para executar uma instalação isolada.
• Script principal do controlador
  • Execute main.py -h para obter mais informações.
• Interface de ponta a ponta
  • Indexação e pesquisa de texto (código -fonte). Suporte interno para Whoosh (pesquisa rápida) ou Xapian (pesquisa muito mais rápida).
    • Estender facilmente a indexação ou a pesquisa por meio de backnds personalizados.
  • O aplicativo da Web do front -end servido usando Werkzeug ou Cheroot.
    • werkzeug é para o desenvolvimento do pequeno tráfego.
    • cheroot é o servidor HTTP de alto desempenho e python usado por Cherrypy.
  • Configurações e configuração usando Python.

Interface da web

Características:

Anexar para documentar o URL.

• Para destacar as linhas, anexar a URL: &hl=3,7,12-14,21
• Para pular para uma linha, apego ao final do URL: #line-3

Usando outros back -ends

Em settings.py :

• Altere os valores default_indexer e default_searcher para corresponder ao nome dado ao back -end.
  • Valores possíveis:
    • whoosh o padrão, nenhum trabalho extra necessário.
    • xapian deve ser instalado separadamente usando o script de configuração setup/install-xapian.sh incluído.

Usando outros servidores da Web

O Text Sherlock possui suporte interno para servidores compatíveis com Werkzeug e Cheroot WSGI.

Em settings.py :

• Altere o valor server_type para um dos tipos de servidores disponíveis.
  • Valores possíveis:
    • default , Werkzeug Web Server (padrão).
    • cheroot , servidor da Web pronta de produção.

Pacotes principais

Requer Python 3.5+

• Whoosh
• Balão
• Jinja2
• Pigmentos
• Peewee
• Bootstrap v4.x
• Pyyaml

Outras referências

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

Objetivos do projeto

1. Forneça uma solução fácil de configurar, rápida e adequada do mecanismo de pesquisa de texto.
2. Seja uma alternativa respeitável ao OpenGrok.
3. Influencie os colaboradores do OpenGrok para fornecer um processo de configuração mais simples.
   • Configurei com sucesso duas instalações do OpenGrok no CentOS e Ubuntu 11.x. Cada vez que levava mais de duas horas . A configuração do Sherlock de texto leva menos de 5 minutos (excluindo o tempo de download do pacote).

Colaboradores

• Christopher Bess
• Raphael Boidol
• E outros ...