Sync deploy-to-heroku with main

.github/actions/setup/action.yaml

@@ -0,0 +1,13 @@
+name: Setup the repository
+description: Set up Python, install Poetry and the dependencies
+runs:
+  using: "composite"
+  steps:
+    - run: pipx install poetry==1.7.1
+      shell: bash
+    - uses: actions/setup-python@v5
+      with:
+        cache: poetry
+        python-version: "3.9.18"
+    - run: poetry install
+      shell: bash

.github/workflows/sync-branches.yml

@@ -7,7 +7,7 @@ on:
 jobs:
   sync:
     name: Sync branches
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     if: >
       !github.event.deleted
     steps:

.github/workflows/test.yml

@@ -6,12 +6,12 @@ on:
 jobs:
   test:
     name: Test
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: ./.github/actions/install-dependencies
-      - run: poetry run app format --check
-      - run: poetry run app sort-imports --check
-      - run: poetry run app lint
-      - run: poetry run app typecheck
-      - run: poetry run app test
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: poetry check --lock
+      - run: poetry run ruff format --check
+      - run: poetry run ruff check
+      - run: poetry run mypy
+      - run: poetry run pytest

.gitignore

@@ -1,6 +1,2 @@
 __pycache__/
-.docker/
-.mypy_cache/
-.pytest_cache/
-.venv/
 content/

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff",
+        "ms-python.python",
+        "tamasfe.even-better-toml"
+    ],
+    "unwantedRecommendations": []
+}

.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+    "[python]": {
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+        },
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.formatOnType": true
+    },
+    "[toml]": {
+        "editor.defaultFormatter": "tamasfe.even-better-toml"
+    },
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "python.analysis.autoImportCompletions": true,
+    "python.languageServer": "Pylance",
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false
+}

CONTRIBUTING.md

@@ -2,6 +2,6 @@
 
 ## Scope
 
-This project is not intended to become a showcase of all atoti's features.
+This project is not intended to become a showcase of all Atoti's features.
 It should have just enough structure to show how to start a project on sound and modular foundations, not more.
-https://docs.atoti.io/ is the right place to discover and learn what atoti can do.
+https://docs.atoti.io is the right place to discover and learn what Atoti can do.

Dockerfile

@@ -1,16 +1,16 @@
 # syntax=docker/dockerfile:1.2
-FROM python:3.9.12-slim AS builder
 
-RUN --mount=type=cache,target=/root/.cache pip install poetry==1.1.12
-RUN poetry config virtualenvs.create false
+# `--platform=linux/am64` is required to build this image on macOS with Apple Silicon until https://github.com/activeviam/jdk4py/issues/73 is done.
+FROM --platform=linux/amd64 python:3.9.18-slim AS builder
+
+RUN pip install poetry==1.7.1
 
 COPY poetry.lock pyproject.toml ./
 
-RUN --mount=type=cache,target=/root/.cache poetry install --no-ansi --no-dev --no-interaction --no-root
+RUN POETRY_VIRTUALENVS_CREATE=false poetry install --no-cache --no-root --only main --sync
 
-FROM python:3.9.12-slim AS runner
+FROM --platform=linux/amd64 python:3.9.18-slim AS runner
 
-ENV ATOTI_DISABLE_TELEMETRY=true
 ENV ATOTI_HIDE_EULA_MESSAGE=true
 ENV PORT=80
 

README.md

@@ -1,15 +1,14 @@
-# atoti Project Template
+# 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.
+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 [Poetry](https://python-poetry.org/)
-- Settings management with [pydantic](https://pydantic-docs.helpmanual.io/usage/settings/)
-- Testing with [pytest](https://docs.pytest.org/)
-- Type checking with [mypy](http://mypy-lang.org/)
-- Formatting with [Black](https://black.readthedocs.io/) and [isort](https://pycqa.github.io/isort/)
-- Linting with [Pylint](https://www.pylint.org/)
+- Dependency management with [Poetry](https://python-poetry.org)
+- Config management with [Pydantic Settings](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
@@ -25,36 +24,17 @@ On top of the `atoti` package, it comes with:
 
 ### Commands
 
-To get a list of the commands that can be executed to interact with the project, run:
+To start the app:
 
 ```bash
-poetry run app --help
+poetry run python -m main
 ```
 
-A few examples:
-
-- Start the app:
-
-  ```bash
-  poetry run app start
-  ```
-
-- Launch the tests:
-
-  ```bash
-  poetry run app test
-  ```
-
-- Reformat the code:
-
-  ```bash
-  poetry run app format
-  ```
+Other useful commands can be found in [`test.yml`](.github/workflows/test.yml).
 
 ## Variants
 
 This repository has the following long-lived branches showcasing different aspects:
 
-- [`atoti-plus`](https://github.com/atoti/project-template/tree/atoti-plus) for upgrading to Atoti+.
 - [`deploy-to-aws`](https://github.com/atoti/project-template/tree/deploy-to-aws) for deploying on AWS ECS.
 - [`deploy-to-heroku`](https://github.com/atoti/project-template/tree/deploy-to-heroku) for a one-click deploy to Heroku.

app/__init__.py

@@ -1,3 +1,5 @@
-from .app import *
+from __future__ import annotations
+
 from .config import *
 from .constants import *
+from .start_app import *

app/__main__.py

@@ -1,7 +1,7 @@
-from . import App, Config
+from __future__ import annotations
 
-config = Config()
+from . import Config, start_app
 
-with App(config=config) as app:
-    print(f"Session listening on port {app.session.port}")
-    app.session.wait()
+with start_app(config=Config()) as session:
+    print(f"Session listening on port {session.port}")  # noqa: T201
+    session.wait()

app/config.py

@@ -1,54 +1,66 @@
+# ruff: noqa: UP007
+# Pydantic evaluates type annotations at runtime which does not support `|`.
+
+from __future__ import annotations
+
 from datetime import timedelta
 from pathlib import Path
-from typing import Any, Optional, Union
+from typing import Annotated, Optional, Union
 
 from pydantic import (
-    BaseSettings,
+    AliasChoices,
     DirectoryPath,
     Field,
     FilePath,
     HttpUrl,
     PostgresDsn,
-    validator,
+    TypeAdapter,
+    field_validator,
 )
+from pydantic_settings import BaseSettings, SettingsConfigDict
 
 from .util import normalize_postgres_dsn_for_atoti_sql
 
 
 class Config(BaseSettings):
-    """Hold all the configuration properties of the app, not only the ones related to atoti.
+    """Hold all the configuration properties of the app, not only the ones related to Atoti.
 
     See https://pydantic-docs.helpmanual.io/usage/settings/.
     """
 
+    model_config = SettingsConfigDict(frozen=True)
+
     data_refresh_period: Optional[timedelta] = timedelta(minutes=1)
 
     # The $PORT environment variable is used by most PaaS to indicate the port the app server should bind to.
     port: int = 9090
 
-    reverse_geocoding_path: Union[HttpUrl, FilePath] = Field(
-        default="https://api-adresse.data.gouv.fr/reverse/csv/"
-    )
+    requests_timeout: timedelta = timedelta(seconds=30)
 
-    user_content_storage: Optional[Union[PostgresDsn, Path]] = Field(
-        default=Path("content"),
-        # $DATABASE_URL is used by some PaaS such to designate the URL of the app's primary database.
-        # For instance: https://devcenter.heroku.com/articles/heroku-postgresql#designating-a-primary-database.
-        env="database_url",
-    )
+    reverse_geocoding_path: Union[HttpUrl, FilePath] = TypeAdapter(
+        HttpUrl
+    ).validate_python("https://api-adresse.data.gouv.fr/reverse/csv/")
+
+    user_content_storage: Annotated[
+        Optional[Union[PostgresDsn, Path]],
+        Field(
+            # $DATABASE_URL is used by some PaaS such to designate the URL of the app's primary database.
+            # For instance: https://devcenter.heroku.com/articles/heroku-postgresql#designating-a-primary-database.
+            validation_alias=AliasChoices("user_content_storage", "database_url")
+        ),
+    ] = Path("content")
 
-    velib_data_base_path: Union[HttpUrl, DirectoryPath] = Field(
-        default="https://velib-metropole-opendata.smoove.pro/opendata/Velib_Metropole"
+    velib_data_base_path: Union[HttpUrl, DirectoryPath] = TypeAdapter(
+        HttpUrl
+    ).validate_python(
+        "https://velib-metropole-opendata.smovengo.cloud/opendata/Velib_Metropole"
     )
 
-    @validator("user_content_storage")
+    @field_validator("user_content_storage")
     @classmethod
-    def normalize_postgresql_dsn(cls, value: Union[PostgresDsn, Any]) -> Any:
-        return (
-            normalize_postgres_dsn_for_atoti_sql(value)
-            if isinstance(value, PostgresDsn)
-            else value
-        )
-
-    class Config:
-        allow_mutation = False
+    def normalize_postgres_dsn(cls, value: object) -> object:
+        try:
+            postgres_dsn: PostgresDsn = TypeAdapter(PostgresDsn).validate_python(value)
+            return normalize_postgres_dsn_for_atoti_sql(postgres_dsn)
+        except ValueError:
+            return value

app/constants.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from enum import Enum