https://github.com/scieloorg/access-counter
https://github.com/scieloorg/access-counter
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/scieloorg/access-counter
- Owner: scieloorg
- Created: 2020-09-21T12:53:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T03:23:40.000Z (almost 2 years ago)
- Last Synced: 2024-07-10T06:04:04.937Z (almost 2 years ago)
- Language: Python
- Size: 73.1 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# access-counter
Gera relatórios em formato COUNTER R5.
## Como instalar
__Criar ambiente virtual para python 3.6+__
```bash
virtualenv -p python3.6 .venv
```
__Acessar ambiente virtual__
```bash
source .venv/bin/activate
```
__Instalar dependências e pacotes__
```bash
apt install libmysqlclient-dev
pip install -r requirements.txt
python setup.py install
```
## Como usar
__Criar banco de dados e tabelas__
```sql
create database matomo
```
```bash
initialize_database -u STRING_CONNECTION
```
__Popular tabela de periódicos__
```bash
populate_journals -u STRING_CONNECTION
```
__Calcular métricas COUNTER__
É preciso setar as variáveis de ambiente listadas ao final deste README.md
```bash
calculate_metrics \
-c COLLECTION_ACRONYM \
-u mysql://user:pass@host:port/database \
--dict_date YYYY-MM-DD \
--use_pretables
```
__Exportar dados para tabelas SUSHI__
É preciso setar as variáveis de ambiente listadas ao final deste README.md
```bash
export_to_database \
-c COLLECTION_ACRONYM \
-u mysql://user:pass@host:port/database \
--auto
```
__Agregar tabelas__
```bash
usage: aggregate [-h] [-c COLLECTION] [-p PERIOD]
[-t {aggr_article_language_year_month_metric,aggr_journal_language_year_month_metric,aggr_journal_geolocation_year_month_metric,aggr_journal_language_yop_year_month_metric,aggr_journal_geolocation_yop_year_month_metric}]
optional arguments:
-h, --help show this help message and exit
-c COLLECTION, --collection COLLECTION
Acrônimo de coleção
-p PERIOD, --period PERIOD
Período de datas a serem agregadas (YYYY-MM-DD,YYYY-
MM-DD)
-t {aggr_article_language_year_month_metric,aggr_journal_language_year_month_metric,aggr_journal_geolocation_year_month_metric,aggr_journal_language_yop_year_month_metric,aggr_journal_geolocation_yop_year_month_metric}, --tables {aggr_article_language_year_month_metric,aggr_journal_language_year_month_metric,aggr_journal_geolocation_year_month_metric,aggr_journal_language_yop_year_month_metric,aggr_journal_geolocation_yop_year_month_metric}
Tabelas a serem preenchidas
```
## Variáveis de ambiente
- COLLECTION
- MATOMO_ID_SITE
- ARTICLEMETA_DATABASE_STRINGorg:27017/articlemeta.articles?authSource
- LOG_FILE_DATABASE_STRING
- MATOMO_DATABASE_STRING
- DIR_DATA
- DIR_PRETABLES
- DIR_SUMMARY
- DIR_R5_HITS
- DIR_R5_METRICS
- LOGGING_LEVEL
- MATOMO_API_TOKEN
- MATOMO_DB_IP_COUNTER_LIMIT
- MATOMO_FIX_DATABASE_COLUMNS
- MATOMO_URL
- MIN_YEAR
- PRETABLE_DAYS_N
- COMPUTING_DAYS_N
- COMPUTING_TIMEDELTA