Metadata-Version: 2.1
Name: dart-trec-commons
Version: 1.0.0
Summary: T-REC Commons libs
Home-page: https://github.sec.samsung.net/SOL/dart-trec-commons
Author: SIDIA
Author-email: sidia@sidia.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: ~=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib-metadata (==4.13.0)
Requires-Dist: minio (==6.0.2)
Requires-Dist: numpy (<2,>=1.22.0)
Requires-Dist: pandas (==1.5.3)
Requires-Dist: pymongo (==4.6.3)
Requires-Dist: scikit-learn (>=1.2.2)

# TREC Commons

Common Python code for T-REC

## How to Run

1. Install requeriments
    - `python3 -m venv .venv`
    - `source ./.venv/bin/activate`
    - `pip install -r requirements.txt`
   
2. Config parameters
    - `cp pytest.ini.example pytest.ini`
    - fill pytest.ini

3. Run tests
    - `make test`

## How to Setup

All application variables to test are exposed in `.pytest.ini`:

- Learner Options:

    | Option | Description |
    |--------|-------------|
    | LEARNER_DAYS_INTERVAL | Learner interval in days |

- Connection Options:

    | Option | Description |
    |--------|-------------|
    | MONGODB_URI | Mongo URI (without database name) |
    | MINIO_HOST | MinIO host (without http://) |
    | MINIO_ACCESS_KEY | MinIO Key |
    | MINIO_SECRET_KEY | MinIO Secret |
    | MINIO_RECOMMENDER_BUCKET | MinIO recommender bucket |



