Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.48 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.48 KB
Raw

Funbro Data Collector

This project downloads data from whatever sources and makes it available in some persistance storage.

Credentials

The project relies on a number of credentials to be available at runtime. Some of them are just environment variables and some are files expected at a given path.

In order to make these credentials available at runtime, just fill the .env* files present at then root of the project.

Actual file credentials are git/docker-ignored, but .env* files are not for convenience. The .env file, which contains production env variables, has some of its keys empty so they are easily filled if needed. In case of being filled, do remember not to version control the changes!

Running it

docker-compose run funbro-data-collector python -m src IMDB_DAILY --dataset ALL

Or just modify the arguments in the makefile and run:

make run

You can ask for help to see what's available:

docker-compose run funbro-data-collector python -m src --help

Each data source can potentially accept different arguments. You can check that invoking its sub-argument parser:

docker-compose run funbro-data-collector python -m src IMDB_DAILY --help

Development

You can make available a local database and force it rebuild running:

make rebuild_db

Run the tests like so:

make test

Run the static code analyzer:

make mypy