Atoti Project Template

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
• Linting with Ruff
• Continuous testing with GitHub Actions

Usage

Installation

• Install poetry

• Install the dependencies:

  poetry install

Commands

To get a list of the commands that can be executed to interact with the project, run:

poetry run app --help

A few examples:

• Start the app:

  poetry run app start

• Launch the tests:

  poetry run app test

• Reformat the code:

  poetry run app format

Variants

This repository has the following long-lived branches showcasing different aspects:

• deploy-to-aws for deploying on AWS ECS.
• deploy-to-heroku for a one-click deploy to Heroku.