A small example project created with the at-python-template.
To set up your local development environment, please use a fresh virtual environment.
Then run:
pip install -r requirements.txt -r requirements-dev.txt
You can now run the module from the src directory with python -m example_project.
If you want to deploy this project as a docker container, please ensure that Docker and Docker Compose are installed, then run
docker-compose up
this will build the entire project with all dependencies inside a docker container. You may use the command line interface of the application now, e.g. by editing the command tag in the docker-compose.yml.
We use pytest as test framework. To execute the tests, please run
python setup.py test
To run the tests with coverage information, please use
python setup.py testcov
and have a look at the htmlcov folder, after the tests are done.
To build a distribution package (wheel), please use
python setup.py dist
this will clean up the build folder and then run the bdist_wheel command.
Before contributing, please set up the pre-commit hooks to reduce errors and ensure consistency
pip install -U pre-commit && pre-commit install
Jane Doe ([email protected])
© [at]