This template can be used to start atoti projects where the goal is to go into production rather than prototyping in a notebook.
On top of the atoti
package, it comes with:
- Dependency management with Poetry
- Settings management with pydantic
- Testing with pytest
- Type checking with mypy
- Formatting with Black and isort
- Linting with Pylint
- Continuous testing with GitHub Actions
-
Install the dependencies:
poetry install
The pyproject.toml
file contains a [tool.poetry.scripts]
section listing the commands that can be executed to interact with the project.
Some of these commands are fixable.
A few examples:
-
Start the app:
poetry run start
-
Launch the tests:
poetry run test
-
Reformat the code:
poetry run format --fix
This branch shows the modifications required to deploy a project to Heroku.
Click on the button below to deploy this project to Heroku:
Note: to deploy a project started from this template, remember to change the repository
value in app.json.