khuyentran1401 / atoti_project

An example data science project using atoti

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
• Testing with pytest
• Type checking with mypy
• Formatting with Black and isort
• Linting with Pylint
• Continuous testing with GitHub Actions

Usage

Installation

• Install poetry

• Install the dependencies:

  poetry install

Commands

• Start the session:

  poetry run python -m app

• Run the tests:

  poetry run pytest

• Check the types:

  poetry run mypy --package app --package tests --show-error-codes

• Sort the imports:

  poetry run isort app/ tests/

• Format the code:

  poetry run black app/ tests/

• Lint the code:

  poetry run pylint app/ tests/

Variants

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

• atoti-plus for upgrading to Atoti+.
• deploy-to-heroku for a one-click deploy to Heroku.