UV migration. (#238)

Author: s3rius

.github/workflows/release.yml

@@ -9,29 +9,28 @@ jobs:
   pypi:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Install poetry
-        run: pipx install poetry
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
-          python-version: "3.11"
-      - name: Install deps
-        run: poetry install
-      - name: Set version
-        run: poetry version "${{ github.ref_name }}"
+          python-version: "3.12"
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7
       - name: Release package
         env:
-          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
-        run: poetry publish --build
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          uv version "${{ github.ref_name }}"
+          uv build
+          uv publish
   docker:
     runs-on: ubuntu-latest
     permissions:
       packages: write
       contents: read
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
     - name: Set up Docker
       uses: docker/setup-qemu-action@v3
     - name: Set up Docker Buildx

.github/workflows/test.yml

@@ -25,19 +25,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v6
         with:
           python-version: '3.12'
-      - name: Install deps
-        run: |
-          pip install -U pip
-          pip install poetry==1.8.2
-          poetry install
         env:
           POETRY_VIRTUALENVS_CREATE: "False"
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v6
       - name: Setup GIT
         run: |
           git config --global user.name "fastapi_template"
           git config --global user.email "[email protected]"
       - name: Run tests
-        run: pytest -vv -n auto
+        run: uv run pytest -vv -n auto

Dockerfile

@@ -1,6 +1,6 @@
-FROM python:3.11.4-alpine
+FROM ghcr.io/astral-sh/uv:0.9.12-python3.13-alpine
 
-RUN apk add --no-cache \
+RUN apk update && apk add --no-cache \
   curl \
   # For building dependencies. \
   gcc \
@@ -16,23 +16,27 @@ RUN apk add --no-cache \
   ncurses \
   bash
 
-RUN adduser --disabled-password fastapi_template
+RUN adduser -u 1000 --disabled-password fastapi_template
 RUN mkdir /projects /src
-RUN chown -R fastapi_template:fastapi_template /projects /src
-USER fastapi_template
 
-WORKDIR /src
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+ENV UV_PROJECT_ENVIRONMENT=/usr/local
+ENV UV_PYTHON_DOWNLOADS=never
+ENV UV_NO_MANAGED_PYTHON=1
 
-ENV PATH ${PATH}:/home/fastapi_template/.local/bin
+WORKDIR /src
+COPY . .
 
-RUN pip install poetry==1.5.1
+ENV PATH="${PATH}:/usr/local/bin"
 
-COPY . /src/
-RUN pip install .
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked --no-dev
 
-USER root
-RUN rm -rfv /src
 RUN apk del curl
+
+RUN chown -R fastapi_template:fastapi_template /projects /src /usr/local/lib/
+
 USER fastapi_template
 
 RUN git config --global user.name "Fastapi Template"
@@ -41,5 +45,4 @@ RUN git config --global user.email "[email protected]"
 VOLUME /projects
 WORKDIR /projects
 
-ENTRYPOINT ["/home/fastapi_template/.local/bin/fastapi_template"]
-
+ENTRYPOINT ["python", "-m", "fastapi_template"]

README.md

@@ -7,9 +7,7 @@
 
 ## Usage
 
-⚠️ [Git](https://git-scm.com/downloads), [Python](https://www.python.org/) and [Poetry](https://python-poetry.org/) must be installed and accessible ⚠️
-
-Poetry version must be greater or equal than 1.1.8. Otherwise it won't be able to install SQLAlchemy.
+⚠️ [Git](https://git-scm.com/downloads), [Python](https://www.python.org/) and [UV](https://docs.astral.sh/uv/) must be installed and accessible ⚠️
 
 <div align="center">
  <a href="https://asciinema.org/a/ig0oi0fOq1hxqnW5X49XaaHIT" target="_blank"><img src="https://asciinema.org/a/ig0oi0fOq1hxqnW5X49XaaHIT.svg" /></a>
@@ -29,7 +27,7 @@ docker-compose up --build
 
 If you want to install it from sources, try this:
 ```shell
-python3 -m pip install poetry
+python3 -m pip install uv 
 python3 -m pip install .
 python3 -m fastapi_template
 ```
@@ -58,7 +56,6 @@ Generator features:
 - Optional redis support;
 - Optional rabbitmq support;
 - different CI\CD;
-- Optional Kubernetes config generation;
 - Optional Demo routers and models (This helps you to see how project is structured);
 - Pre-commit integration;
 - Generated tests with almost 90% coverage;
@@ -93,7 +90,6 @@ Options:
   --rabbit                        Add RabbitMQ support
   --taskiq                        Add Taskiq support
   --migrations                    Add Migrations
-  --kube                          Add kubernetes configs
   --dummy                         Add dummy model
   --routers                       Add example routers
   --swagger                       Add self hosted swagger

fastapi_template/cli.py

@@ -80,8 +80,7 @@ def checker(ctx: BuilderContext) -> bool:
                 "Choose this option if you want to create a service with {name}.\n"
                 "It's more suitable for {generic} web-services or services without databases.".format(
                     name=colored("REST API", color="green"),
-                    generic=colored("generic", color="cyan",
-                                    attrs=["underline"]),
+                    generic=colored("generic", color="cyan", attrs=["underline"]),
                 )
             ),
         ),
@@ -152,8 +151,7 @@ def checker(ctx: BuilderContext) -> bool:
                 "{name} is the most popular database made by oracle.\n"
                 "It's a good fit for {prod} application.".format(
                     name=colored("MySQL", color="green"),
-                    prod=colored("production-grade", color="cyan",
-                                 attrs=["underline"]),
+                    prod=colored("production-grade", color="cyan", attrs=["underline"]),
                 )
             ),
             additional_info=Database(
@@ -172,13 +170,12 @@ def checker(ctx: BuilderContext) -> bool:
                 "{name} is second most popular open-source relational database.\n"
                 "It's a good fit for {prod} application.".format(
                     name=colored("PostgreSQL", color="green"),
-                    prod=colored("production-grade", color="cyan",
-                                 attrs=["underline"]),
+                    prod=colored("production-grade", color="cyan", attrs=["underline"]),
                 )
             ),
             additional_info=Database(
                 name="postgresql",
-                image="postgres:16.3-bullseye",
+                image="postgres:18.1-bookworm",
                 async_driver="postgresql+asyncpg",
                 driver_short="postgres",
                 driver="postgresql",
@@ -199,9 +196,9 @@ def checker(ctx: BuilderContext) -> bool:
                 async_driver="beanie",
                 driver_short="mongodb",
                 driver="mongodb",
-                port=27017
+                port=27017,
             ),
-        )
+        ),
     ],
 )
 
@@ -265,8 +262,7 @@ def checker(ctx: BuilderContext) -> bool:
                 "If you select this option, you will get only {what}.\n"
                 "The rest {warn}.".format(
                     what=colored("raw database", color="green"),
-                    warn=colored("is up to you", color="red",
-                                 attrs=["underline"]),
+                    warn=colored("is up to you", color="red", attrs=["underline"]),
                 )
             ),
         ),
@@ -342,7 +338,6 @@ def checker(ctx: BuilderContext) -> bool:
                 )
             ),
         ),
-
     ],
 )
 
@@ -365,8 +360,7 @@ def checker(ctx: BuilderContext) -> bool:
                         color="green",
                     ),
                     purpose1=colored("caching", color="cyan"),
-                    purpose2=colored(
-                        "storing temporary variables", color="cyan"),
+                    purpose2=colored("storing temporary variables", color="cyan"),
                 )
             ),
         ),
@@ -419,7 +413,7 @@ def checker(ctx: BuilderContext) -> bool:
             code="enable_migrations",
             cli_name="migrations",
             user_view="Add Migrations",
-            is_hidden=lambda ctx: ctx.db == "none",
+            is_hidden=lambda ctx: ctx.db == "none" or ctx.orm == "psycopg",
             description=(
                 "Add database {what} config.\n"
                 "This options adds ability to {why} database schema.".format(
@@ -428,19 +422,6 @@ def checker(ctx: BuilderContext) -> bool:
                 )
             ),
         ),
-        MenuEntry(
-            code="enable_kube",
-            cli_name="kube",
-            user_view="Add kubernetes configs",
-            description=(
-                "This option will add {what} manifests to your project.\n"
-                "But this option is {warn}, since if you want to use k8s, please create helm.".format(
-                    what=colored("kubernetes", color="green"),
-                    warn=colored("deprecated", color="red",
-                                 attrs=["underline"]),
-                )
-            ),
-        ),
         MenuEntry(
             code="add_dummy",
             cli_name="dummy",
@@ -641,7 +622,6 @@ def inner_callback(**cli_args: Any):
                 "Project name: ",
                 validator=SnakeCaseValidator(),
             )
-        context.kube_name = context.project_name.replace("_", "-")
 
         for menu in menus:
             if menu.need_ask(context):
@@ -699,7 +679,7 @@ def run_command(callback: Callable[[BuilderContext], None]) -> None:
     for menu in menus:
         cmd.params.extend(menu.get_cli_options())
     required_commands = {
-        "poetry": "https://python-poetry.org/docs/#installation",
+        "uv": "https://docs.astral.sh/uv/",
         "git": "https://git-scm.com/",
     }
     for prog, link in required_commands.items():

fastapi_template/template/cookiecutter.json

@@ -23,12 +23,6 @@
     "enable_taskiq": {
         "type": "bool"
     },
-    "enable_kube": {
-        "type": "bool"
-    },
-    "kube_name": {
-        "type": "string"
-    },
     "enable_routers": {
         "type": "bool"
     },

fastapi_template/template/hooks/post_gen_project.py

@@ -61,10 +61,10 @@ def init_repo():
     cprint("Git repository initialized.", "green")
     subprocess.run(["git", "add", "."], stdout=subprocess.PIPE)
     cprint("Added files to index.", "green")
-    subprocess.run(["poetry", "install", "-n"])
-    subprocess.run(["poetry", "run", "pre-commit", "install"])
+    subprocess.run(["uv", "sync"])
+    subprocess.run(["uv", "run", "pre-commit", "install"])
     cprint("pre-commit installed.", "green")
-    subprocess.run(["poetry", "run", "pre-commit", "run", "-a"])
+    subprocess.run(["uv", "run", "pre-commit", "run", "-a"])
     subprocess.run(["git", "add", "."], stdout=subprocess.PIPE)
     subprocess.run(["git", "commit", "-m", "Initial commit"], stdout=subprocess.PIPE)
 

fastapi_template/template/{{cookiecutter.project_name}}/.gitlab-ci.yml

@@ -3,23 +3,21 @@ stages:
 
 .test-template:
   stage: test
-  image: python:3.11.4-slim-bullseye
+  image: ghcr.io/astral-sh/uv:0.9.12-python3.13-bookworm-slim
   tags:
     - kubernetes-runner
     - docker-runner
   except:
     - tags
   before_script:
     - apt update && apt install -y git
-    - pip install poetry==1.8.2
-    - poetry config virtualenvs.create false
-    - poetry install
+    - uv sync
 
 black:
   extends:
     - .test-template
   script:
-    - pre-commit run black -a
+    - pre-commit run ruff-format -a
 
 ruff:
   extends:
@@ -31,5 +29,5 @@ mypy:
   extends:
     - .test-template
   script:
-    - pre-commit run ruff -a
+    - pre-commit run mypy -a
 

fastapi_template/template/{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -5,25 +5,27 @@ repos:
     - repo: local
       hooks:
 
-          - id: black
-            name: Format with Black
-            entry: poetry run black
+          - id: ruff-format
+            name: Format with Ruff
+            entry: uv run ruff format
             language: system
-            types: [python]
+            pass_filenames: false
+            always_run: true
 
           - id: ruff
             name: Check with Ruff
-            entry: poetry run ruff
+            entry: uv run ruff
             language: system
             pass_filenames: false
             always_run: true
             args: ["check", "{{cookiecutter.project_name}}", "tests", "--fix"]
 
           - id: mypy
             name: Validate types with MyPy
-            entry: poetry run mypy
+            entry: uv run mypy
             language: system
             types: [python]
             pass_filenames: false
             args:
               - "{{cookiecutter.project_name}}"
+              - "tests"