https://github.com/atoti/project-template

Template from which Atoti projects intending to go into production can start
https://github.com/atoti/project-template

atoti project-template

Last synced: 1 day ago
JSON representation

Template from which Atoti projects intending to go into production can start

• Host: GitHub
• URL: https://github.com/atoti/project-template
• Owner: atoti
• Created: 2021-02-01T10:51:48.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T19:50:56.000Z (about 2 months ago)
• Last Synced: 2024-09-18T03:07:02.906Z (about 2 months ago)
• Topics: atoti, project-template
• Language: Python
• Homepage: https://docs.atoti.io/latest/deployment/going_from_a_notebook_to_an_app.html
• Size: 544 KB
• Stars: 37
• Watchers: 3
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# 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](https://docs.atoti.io/latest/deployment/going_from_a_notebook_to_an_app.html).

On top of the `atoti` package, it comes with:

- Dependency management with [uv](https://docs.astral.sh/uv)

- Config management with [Pydantic](https://docs.pydantic.dev/2.6/concepts/pydantic_settings)

- Testing with [pytest](https://docs.pytest.org)

- Type checking with [mypy](http://mypy-lang.org)

- Formatting and linting with [Ruff](https://docs.astral.sh/ruff)

- Continuous testing with [GitHub Actions](https://github.com/features/actions)

## Usage

### Installation

- [Install `uv`](https://docs.astral.sh/uv/getting-started/installation)

- Install the dependencies:

  ```bash

  uv sync

  ```

### Commands

To start the app:

```bash

uv run python -m app

```

Other useful commands can be found in [`test.yml`](.github/workflows/test.yml).

## Deployment

This repository automatically deploys to [AWS ECS](https://aws.amazon.com/ecs/).

To deploy somewhere else, delete [`task-definition.json`](task-definition.json) and adapt [`deploy.yml`](.github/workflows/deploy.yml).