infrascielo/analytics repository overview

⁠Analytics

Interface web para consulta de indicadores de acessos e publicação das coleções da rede SciELO.

⁠Arquivos: Dockerfile* e docker-compose*.yml

⁠Dockerfile

• Dockerfile: define a imagem para produção.
• Dockerfile-dev: define a imagem para desenvolvimento, com ferramentas adicionais e configuração para debug.

⁠Docker Compose

• docker-compose.yml: inicia todos os containers necessários para produção.
• docker-compose-dev.yml: inicia todos os containers necessários para desenvolvimento, incluindo Memcached, VPN, etc.

⁠Execução dos testes

Para testes, é mais prático usar um ambiente virtual Python em vez de containers Docker.

1. Instale a dependência de sistema libmemcached-dev (no Ubuntu/Debian):

sudo apt install libmemcached-dev

1. Crie um ambiente virtual Python 3.6 (usando miniconda):

conda create -n scl-analytics python=3.6 -y
conda activate scl-analytics

1. Instale as dependências:

pip install deps/scielojcr-1.3.0-py2.py3-none-any.whl
pip install -r requirements.txt

1. Execute os testes de unidade:

python setup.py test

docker run -d --name memcached-dev -p 11211:11211 memcached:latest

⁠Integrações

O Analytics integra cinco serviços principais:

• Article Meta: GitHub⁠
• Publication Stats: GitHub⁠
• Access Stats: GitHub⁠
• Bibliometrics: GitHub⁠
• SUSHI API: GitHub⁠

⁠Conexões necessárias

telnet articlemeta.scielo.org 11621

Se conectar, o host tem acesso à porta do serviço.

⁠Executando a aplicação (desenvolvimento)

1. Crie o arquivo development.ini a partir do template:

cp development.ini-TEMPLATE development.ini

1. Certifique-se de que Memcached está acessível:

   • Fora do Docker: use docker run -d --name memcached-dev -p 11211:11211 memcached:latest
   • Dentro do Docker Compose: o serviço já estará configurado.

2. Construir o container:

docker-compose -f docker-compose-dev.yml build --no-cache

1. Iniciar o container:

docker-compose -f docker-compose-dev.yml up

1. Conectar-se à VPN SciELO (necessário para acessar alguns serviços).

2. Acessar a interface web:

http://0.0.0.0:6543

⁠Alterando a aplicação (desenvolvimento)

Sempre que fizer alterações:

1. Construir o container (docker-compose build --no-cache)
2. Iniciar o container (docker-compose up)
3. Conectar à VPN SciELO
4. Acessar a interface web (http://0.0.0.0:6543)

⁠Internacionalização

Para adicionar ou atualizar strings de tradução, siga os passos abaixo.

⁠1. Marcar Strings para Tradução

Nos templates Mako (.mako), envolva as strings com ${_(u'texto para traduzir')}. Em arquivos Python (.py), use _('texto para traduzir') após importar o tradutor.

⁠2. Extrair Novas Strings

Execute o comando abaixo na raiz do projeto para extrair as strings marcadas para um arquivo de modelo (.pot):

python setup.py extract_messages

⁠3. Atualizar os Arquivos de Tradução

Atualize os arquivos de tradução (.po) de cada idioma com as novas strings do arquivo de modelo:

python setup.py update_catalog

⁠4. Traduzir as Strings

Edite os arquivos .po em analytics/locale/<idioma>/LC_MESSAGES/analytics.po e adicione as traduções para as strings com msgstr "".

⁠5. Compilar as Traduções

Compile os arquivos .po para o formato binário (.mo), que é usado pela aplicação:

python setup.py compile_catalog