Develop

.dockerignore

@@ -0,0 +1,5 @@
+.venv/
+__pycache__/
+.idea/
+.git/
+.env

.env.example

@@ -0,0 +1,23 @@
+# Переменные для аппы
+APP_NAME="Task Management API"  # app/core/config.py
+API_V1_STR="/api/v1"  # app/core/config.py
+ASYNC_DATABASE_URL="postgresql+asyncpg://postgres:postgres@db:5432/postgres"  # app/core/config.py
+SYNC_DATABASE_URL="postgresql://postgres:postgres@db:5432/postgres"  # app/alembic/env.py
+ASYNC_TEST_DATABASE_URL="postgresql+asyncpg://postgres:postgres@test_db:5432/postgres"
+SYNC_TEST_DATABASE_URL="postgresql://postgres:postgres@test_db:5432/postgres"
+DESCRIPTION="API for managing tasks and users"  # app/core/config.py
+DEBUG=False  # app/core/config.py
+
+# Переменные для БД
+POSTGRES_PASSWORD=postgres  # docker-compose (db)
+POSTGRES_USER=postgres  # docker-compose (db)
+DATABASE_DB=postgres  # docker-compose (db)
+
+# Переменные для портов
+DB_HOST_PORT=5433  # docker-compose (db)
+DB_CONTAINER_PORT=5432  # docker-compose (db)
+TEST_DB_HOST_PORT=5434
+APP_HOST_PORT=8080  # docker-compose (app) & app/core/config.py
+APP_CONTAINER_PORT=8085  # docker-compose (app)
+
+MODE=PRODUCTION

.github/workflows/ci.yml

@@ -0,0 +1,126 @@
+name: CI Workflow
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  api-tests-only:
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -U postgres -d postgres"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      APP_NAME: "Task Management API"
+      API_V1_STR: "/api/v1"
+      ASYNC_DATABASE_URL: "postgresql+asyncpg://postgres:postgres@localhost:5432/postgres"
+      DESCRIPTION: "API for managing tasks and users"
+      DEBUG: False
+      APP_HOST_PORT: 8080
+      MODE: TEST
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: pip install uv
+
+      - name: Sync dependencies
+        run: uv sync --extra ci --no-cache
+
+      - name: Wait for PostgreSQL
+        run: |
+          for i in {1..10}; do
+            pg_isready -h localhost -p 5432 && echo "DB is ready" && exit 0
+            echo "Waiting for DB..."
+            sleep 3
+          done
+          echo "DB did not become available in time" && exit 1
+
+      - name: Run migrations
+        env:
+          SYNC_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres
+        run: uv run alembic upgrade head
+
+      - name: Run API tests
+        env:
+          DATABASE_URL: postgresql+asyncpg://postgres:postgres@localhost:5432/postgres
+          SYNC_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres
+        run: uv run pytest -vv tests/test_api.py
+
+  all-tests:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -U postgres -d postgres"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      APP_NAME: "Task Management API"
+      API_V1_STR: "/api/v1"
+      ASYNC_DATABASE_URL: "postgresql+asyncpg://postgres:postgres@localhost:5432/postgres"
+      DESCRIPTION: "API for managing tasks and users"
+      DEBUG: False
+      APP_HOST_PORT: 8080
+      MODE: TEST
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: pip install uv
+
+      - name: Sync dependencies
+        run: uv sync --extra ci --no-cache
+
+      - name: Wait for PostgreSQL
+        run: |
+          for i in {1..10}; do
+            pg_isready -h localhost -p 5432 && echo "DB is ready" && exit 0
+            echo "Waiting for DB..."
+            sleep 3
+          done
+          echo "DB did not become available in time" && exit 1
+
+      - name: Run migrations
+        env:
+          SYNC_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres
+        run: uv run alembic upgrade head
+
+      - name: Run all tests
+        env:
+          DATABASE_URL: postgresql+asyncpg://postgres:postgres@localhost:5432/postgres
+          SYNC_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres
+        run: uv run pytest -vv

.gitignore

@@ -1,3 +1,177 @@
-.venv
-.idea/
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
 __pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.idea
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+      - id: isort

.test.env

@@ -0,0 +1,20 @@
+# Переменные для самой аппы
+APP_NAME="Task Management API"  # app/core/config.py
+API_V1_STR="/api/v1"  # app/core/config.py
+ASYNC_DATABASE_URL="postgresql+asyncpg://postgres:postgres@localhost:5434/postgres"  # app/core/config.py
+SYNC_DATABASE_URL="postgresql://postgres:postgres@localhost:5434/postgres" # app/alembic/env.py
+DESCRIPTION="API for managing tasks and users"  # app/core/config.py
+DEBUG=True  # app/core/config.py
+
+# Переменные для БД
+POSTGRES_PASSWORD=postgres  # docker-compose (db)
+POSTGRES_USER=postgres  # docker-compose (db)
+DATABASE_DB=postgres  # docker-compose (db)
+
+# Переменные для портов
+DB_CONTAINER_PORT=5432  # docker-compose (db)
+TEST_DB_HOST_PORT=5434
+APP_HOST_PORT=8080  # docker-compose (app) & app/core/config.py
+APP_CONTAINER_PORT=8085  # docker-compose (app)
+
+MODE=TEST

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.12-slim
+
+WORKDIR /todo
+
+RUN pip install --no-cache-dir uv
+
+COPY uv.lock pyproject.toml /todo/
+
+RUN uv sync --frozen --no-cache
+
+COPY . /todo/
+
+ENV PYTHONWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+ENV PYTHONPATH=/todo
+
+CMD uv run alembic upgrade head && uv run python app/main.py