Development Installation¶
Development install¶
After forking or checking out:
$ cd loafer/
$ python setup.py develop
$ pip install -r requirements/local.txt
$ pip install -r requirements/test.txt
$ pre-commit install
The requirements folder are only used for development, so we can easily install/track dependencies required to run the tests using continuous integration platforms.
The official entrypoint for distritubution is the setup.py
which also
contains the minimum requirements to execute the tests.
It’s important to execute setup.py develop
not only to install the main
dependencies, but also to include loafer
CLI in our environment.
Running tests:
$ make test
Generating documentation:
$ cd docs/
$ make html
To configure AWS access, check boto3 configuration or export (see boto3 envvars):
$ export AWS_ACCESS_KEY_ID=<key>
$ export AWS_SECRET_ACCESS_KEY=<secret>
$ export AWS_DEFAULT_REGION=sa-east-1 # for example
Check the Settings section to see specific configurations.