odin

MBTA application responsible for ingesting and aggregating fares related data.

Developer Usage

Dependencies

asdf is used to mange runtime versions using the command line. Once installed, run the following in the root project directory:

# add project plugins
asdf plugin-add python
asdf plugin-add direnv

# install versions of plugins specified in .tool-versions
asdf install

Creating Local Environment

direnv manages the loading/unloading of environmental variables, as well as the creation of a local python virtual environment for development. Using direnv, whenever a shell moves into the project directory, appropriate environmental variables will be loaded automagically and the python virtual environment will be activated.

copy .env.template to .env to bootstrap the expected project environmental variables.

direnv - python layout combined with pip-tools is used by to manage python dependencies and the local python virtual environment. Python package dependencies are defined in pyproject.toml.

Run the config_venv.sh script after a repository clone, or after changing pyproject.toml dependencies.

# script updates `requirements` files and syncs packages to local python virtual environment.
./config_venv.sh

Containers

docker is required to run containerized version of application for local development.