merge from faastapi-minimum

Author: andredias

Makefile

@@ -20,8 +20,8 @@ test:
 	--keep-project-on-failure -o /tmp .
 
 	cd /tmp/$(TARGET_NAME); \
-	poetry run make lint && \
-	poetry run make test && \
-	poetry run make audit && \
-	poetry run make smoke_test && \
+	uv run make lint && \
+	uv run make test && \
+	uv run make audit && \
+	uv run make smoke_test && \
 	echo '\nSuccess!'

README.rst

@@ -16,8 +16,8 @@ Features
 
 * FastAPI_ web framework
 * Asynchronous database support based on `Encode Databases`_ and `SQLAlchemy Core`_
-* Python 3.12+ (configurable)
-* Poetry_ based dependency management
+* Python 3.14+ (configurable)
+* uv_ based dependency management
 * Development tasks registered in a ``Makefile`` for easy access and management
 * Custom Mercurial/Git hooks for ``pre-commit`` and ``pre-push`` events
 * Linting based on ruff_, mypy_ and others
@@ -36,17 +36,21 @@ Instructions
 ============
 
 To instantiate the template into a new project, you'll need cookiecutter_ (>=2.4.0).
-The best way to use it just once is through pipx_:
+The best way to use it just once is through uvx_:
 
 .. code:: console
 
+<<<<<<< working copy
     $ pipx run cookiecutter gh:andredias/perfect_python_project -c fastapi-complete
+=======
+    $ uvx run cookiecutter gh:andredias/perfect_python_project -c fastapi-minimum
+>>>>>>> merge rev
 
-If you prefer, use can install it throught `pip` instead:
+If you prefer, use can install it throught ``uv tool`` instead:
 
 .. code:: console
 
-    $ pip install --user cookiecutter
+    $ uv tool install cookiecutter
 
 Next, run the following command:
 
@@ -85,9 +89,9 @@ That's it!
 .. _HTTPX: https://www.python-httpx.org/
 .. _Loguru: https://github.com/Delgan/loguru
 .. _mypy: http://mypy-lang.org/
-.. _pipx: https://pypa.github.io/pipx/
-.. _Poetry: https://python-poetry.org/
 .. _pytest: https://pytest.org
 .. _python-dotenv: https://pypi.org/project/python-dotenv/
 .. _ruff: https://pypi.org/project/ruff/
 .. _SQLAlchemy Core: https://docs.sqlalchemy.org/en/latest/core/
+.. _uv: https://docs.astral.sh/uv/
+.. _uvx: https://docs.astral.sh/uv/guides/tools/

cookiecutter.json

@@ -1,9 +1,9 @@
 {
   "author": "",
   "email": "",
-  "project_name": "Perfect Python Project",
+  "project_name": "Perfect_FastAPI_Project",
   "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
-  "python_version": "3.12",
+  "python_version": "3.14",
   "line_length": 100,
   "version_control": [
     "hg",

hooks/post_gen_project.sh

@@ -4,10 +4,8 @@ set -xuo pipefail
 
 cp sample.env .env
 rm alembic/versions/empty.txt  # empty.txt was used to keep the alembic folder in version control
-poetry env use {{cookiecutter.python_version}}
-poetry lock --no-update
-poetry install
-poetry run make format
+uv sync --no-install-project
+uv run make format
 
 commit_message="Initial project structure based on https://github.com/andredias/perfect_python_project/tree/fastapi-complete"
 
@@ -27,12 +25,12 @@ make install_hooks
 # initial migration for alembic
 docker compose up -d db
 sleep 5
-poetry run alembic revision --autogenerate -m "Initial migration"
+uv run alembic revision --autogenerate -m "Initial migration"
 docker compose down
 
 # use a separated commit for the initial migration
 # so it can be easily reverted if needed
-poetry run make format
+uv run make format
 if [ "{{cookiecutter.version_control}}" == "hg" ]; then
     hg commit -Am 'Initial alembic migration'
 else

{{cookiecutter.project_slug}}/.dockerignore

@@ -2,7 +2,9 @@
 !alembic*
 !entrypoint.sh
 !migrate_database.py
+!entrypoint.sh
 !pyproject.toml
-!poetry.lock
+!README.rst
+!uv.lock
 !{{cookiecutter.project_slug}}/
 **/__pycache__

{{cookiecutter.project_slug}}/.github/workflows/continuous_integration.yml

@@ -8,38 +8,37 @@ jobs:
         runs-on: ubuntu-latest
         steps:
 
-            - name: Set up python
-              uses: actions/setup-python@v4
-              with:
-                  python-version: '{{cookiecutter.python_version}}'
-
             - name: Check out repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v5
 
-            - name: Install Poetry
-              uses: snok/install-poetry@v1
+            - name: Set up python
+              uses: actions/setup-python@v6
               with:
-                  virtualenvs-in-project: true
+                  python-version-file: "pyproject.toml"
 
-            - name: Load cached venv
-              id: cached-poetry-dependencies
-              uses: actions/cache@v3
+            - name: Install uv
+              uses: astral-sh/setup-uv@v6
               with:
-                  path: .venv
-                  key: venv-{{ "${{ hashFiles('**/poetry.lock') }}" }}
+                  version: "0.9.8"
+                  enable-cache: true
 
             - name: Install dependencies
-              if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-              run: poetry install --no-interaction
+              run: uv sync --locked --no-install-project
+
+            - name: Testing
+              run: uv run --locked make test
 
             - name: Linting
-              run: poetry run make lint
+              run: uv run --locked make lint
 
             - name: Auditing
-              run: poetry run make audit
+              run: uv run make audit
 
-            - name: Test
-              run: poetry run make test
+            - name: Building
+              run: docker compose build
 
             - name: Smoke Test
-              run: poetry run make smoke_test
+              run: uv run make smoke_test
+
+            - name: Minimize uv cache
+              run: uv cache prune --ci

{{cookiecutter.project_slug}}/Dockerfile

@@ -1,33 +1,77 @@
-FROM python:{{cookiecutter.python_version}}-slim as builder
+# syntax=docker/dockerfile:1
+
+FROM python:3.14-slim AS builder
+LABEL maintainer="André Felipe Dias <andref.dias@gmail.com>"
+
+RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
+    apt-get install -y --no-install-recommends build-essential libffi-dev libxml2-dev \
+    libxslt-dev curl libpq-dev && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+# ref: https://github.com/astral-sh/uv-docker-example/blob/main/multistage.Dockerfile
+
+COPY --from=ghcr.io/astral-sh/uv:0.9.8 /uv /uvx /bin/
+
+ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy UV_PYTHON_DOWNLOADS=0
+
+WORKDIR /app
+
+COPY pyproject.toml uv.lock ./
+RUN uv sync --locked --no-install-project --no-dev
+
+# ---------------------------------------------------------
+
+FROM python:3.14-slim AS final
+
+RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
+    apt-get install -y --no-install-recommends libpq-dev && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+COPY --from=builder --chown=nobody:nogroup /app/.venv ./.venv
+ENV PATH=/app/.venv/bin:${PATH}
+
+COPY --chown=nobody:nogroup --exclude=pyproject.toml --exclude=uv.lock . ./
+
+USER nobody
+
+EXPOSE 5000
+
+CMD ["./entrypoint.sh"]
+
+# ---------------------------------------------------------
+
+FROM python:{{cookiecutter.python_version}}-slim AS builder
 LABEL maintainer="{{cookiecutter.author}} <{{cookiecutter.email}}>"
 
 RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
-    apt-get install -y --no-install-recommends build-essential libpq-dev curl && \
+    apt-get install -y --no-install-recommends build-essential libffi-dev libxml2-dev \
+    libxslt-dev curl libpq-dev && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
-ENV PYTHONDONTWRITEBYTECODE=1
-ENV PYTHONUNBUFFERED=1
-RUN python -m venv /venv
+COPY --from=ghcr.io/astral-sh/uv:0.9.8 /uv /uvx /bin/
 
-ENV POETRY_VERSION=1.8.2
-ENV POETRY_HOME=/opt/poetry
-SHELL ["/bin/bash", "-o", "pipefail", "-c"]
-RUN curl -sSL https://install.python-poetry.org | python -
+ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy UV_PYTHON_DOWNLOADS=0
 
 WORKDIR /app
-COPY pyproject.toml poetry.lock ./
-RUN . /venv/bin/activate; \
-    $POETRY_HOME/bin/poetry install --only main --no-interaction
 
+COPY pyproject.toml uv.lock ./
+RUN uv sync --locked --no-install-project --no-dev
 
-FROM python:{{cookiecutter.python_version}}-slim as final
+# ---------------------------------------------------------
 
-COPY --from=builder /venv /venv
-ENV PATH=/venv/bin:${PATH}
+FROM python:{{cookiecutter.python_version}}-slim AS final
 
 WORKDIR /app
+COPY --from=builder --chown=nobody:nogroup /app/.venv ./.venv
+ENV PATH=/app/.venv/bin:${PATH}
+
+COPY --chown=nobody:nogroup --exclude=pyproject.toml --exclude=uv.lock . ./
+
 USER nobody
-COPY --chown=nobody:nogroup {{cookiecutter.project_slug}}/ ./{{cookiecutter.project_slug}}
+EXPOSE 5000
 
 CMD ["./entrypoint.sh"]

{{cookiecutter.project_slug}}/Makefile

@@ -44,4 +44,7 @@ install_hooks:
 
 
 check_env:
-	@ if [ ! -f ".env" ]; then echo '.env not found'; exit 1; fi
+	@ if [ ! -f ".env" ]; then \
+		cp sample.env .env; \
+		echo '.env created from sample.env'; \
+	fi

{{cookiecutter.project_slug}}/docker-compose.dev.yml

@@ -1,15 +1,5 @@
 services:
     app:
-        command:
-            [
-                "hypercorn",
-                "--worker-class={{ cookiecutter.worker_class }}",
-                "--bind=0.0.0.0:5000",
-                "--error-logfile=-",
-                "--reload",
-                "--root-path=/api",
-                "{{cookiecutter.project_slug}}.main:app"
-            ]
         volumes:
             - ./{{cookiecutter.project_slug}}/:/app/{{cookiecutter.project_slug}}/
         environment:

{{cookiecutter.project_slug}}/docker-compose.yml

@@ -43,15 +43,6 @@ services:
         environment:
             DB_HOST: db
             ENV: ${ENV:-production}
-        command:
-            [
-                "hypercorn",
-                "--worker-class={{cookiecutter.worker_class}}",
-                "--bind=0.0.0.0:5000",
-                "--error-logfile=-",
-                "--root-path=/api",
-                "{{cookiecutter.project_slug}}.main:app"
-            ]
 
 volumes:
     caddy_data: