Adopt uv as package manager

Author: foarsitter

README.md

@@ -84,11 +84,11 @@ and then editing the results to include your name, email, and various configurat
 
 First, get Cookiecutter. Trust me, it's awesome:
 
-    $ pip install "cookiecutter>=1.7.0"
+    $ uv tool install "cookiecutter>=1.7.0"
 
 Now run it against this repo:
 
-    $ cookiecutter https://github.com/cookiecutter/cookiecutter-django
+    $ uvx cookiecutter https://github.com/cookiecutter/cookiecutter-django
 
 You'll be prompted for some values. Provide them, then a Django project will be created for you.
 

docs/2-local-development/developing-locally-docker.rst

@@ -36,6 +36,24 @@ This can take a while, especially the first time you run this particular command
 
 Generally, if you want to emulate production environment use ``docker-compose.production.yml`` instead. And this is true for any other actions you might need to perform: whenever a switch is required, just do it!
 
+After we have created our initial image we nee to generate a lockfile for our dependencies.
+Docker cannot write to the host system during builds, so we have to run the command to generate the lockfile in the container.
+This is important for reproducible builds and to ensure that the dependencies are installed correctly in the container.
+Updating the lockfile manually is normally not necessary when you add packages through `uv add <package_name>`.
+
+    $ docker compose -f docker-compose.local.yml run --rm django uv lock
+
+This is done by running the following command: ::
+
+    $ docker compose -f docker-compose.local.yml run --rm django uv lock
+
+To be sure we are on the right track we need to build our image again: ::
+
+    $ docker compose -f docker-compose.local.yml build
+
+
+
+
 Before doing any git commit, `pre-commit`_ should be installed globally on your local machine, and then::
 
     $ git init
@@ -154,10 +172,10 @@ This tells our computer that all future commands are specifically for the dev1 m
 Add 3rd party python packages
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To install a new 3rd party python package, you cannot use ``pip install <package_name>``, that would only add the package to the container. The container is ephemeral, so that new library won't be persisted if you run another container. Instead, you should modify the Docker image:
-You have to modify the relevant requirement file: base, local or production by adding: ::
+To install a new 3rd party python package, you cannot use ``uv add <package_name>``, that would only add the package to the container. The container is ephemeral, so that new library won't be persisted if you run another container. Instead, you should modify the Docker image:
+You have to modify pyproject.toml and either add it to project.dependencies or to tool.uv.dev-dependencies by adding: ::
 
-    <package_name>==<package_version>
+    "<package_name>==<package_version>"
 
 To get this change picked up, you'll need to rebuild the image(s) and restart the running container: ::
 

docs/2-local-development/developing-locally.rst

@@ -1,37 +1,27 @@
 Getting Up and Running Locally
 ==============================
 
-.. index:: pip, virtualenv, PostgreSQL
+.. index:: PostgreSQL
 
 
 Setting Up Development Environment
 ----------------------------------
 
 Make sure to have the following on your host:
 
-* Python 3.12
+* uv https://docs.astral.sh/uv/getting-started/installation/
 * PostgreSQL_.
 * Redis_, if using Celery
 * Cookiecutter_
 
-First things first.
-
-#. Create a virtualenv: ::
-
-    $ python3.12 -m venv <virtual env path>
-
-#. Activate the virtualenv you have just created: ::
-
-    $ source <virtual env path>/bin/activate
-
 #. .. include:: generate-project-block.rst
 
 #. Install development requirements: ::
 
     $ cd <what you have entered as the project_slug at setup stage>
-    $ pip install -r requirements/local.txt
+    $ uv sync
     $ git init # A git repo is required for pre-commit to install
-    $ pre-commit install
+    $ uv run pre-commit install
 
    .. note::
 
@@ -71,15 +61,15 @@ First things first.
 
 #. Apply migrations: ::
 
-    $ python manage.py migrate
+    $ uv run python manage.py migrate
 
 #. If you're running synchronously, see the application being served through Django development server: ::
 
-    $ python manage.py runserver 0.0.0.0:8000
+    $ uv run python manage.py runserver 0.0.0.0:8000
 
    or if you're running asynchronously: ::
 
-    $ uvicorn config.asgi:application --host 0.0.0.0 --reload --reload-include '*.html'
+    $ uv run uvicorn config.asgi:application --host 0.0.0.0 --reload --reload-include '*.html'
 
    If you've opted for Webpack or Gulp as frontend pipeline, please see the :ref:`dedicated section <bare-metal-webpack-gulp>` below.
 
@@ -136,7 +126,7 @@ Following this structured approach, here's how to add a new app:
 
 #. **Create the app** using Django's ``startapp`` command, replacing ``<name-of-the-app>`` with your desired app name: ::
 
-    $ python manage.py startapp <name-of-the-app>
+    $ uv run python manage.py startapp <name-of-the-app>
 
 #. **Move the app** to the Django Project Root, maintaining the project's two-tier structure: ::
 
@@ -203,14 +193,14 @@ Next, make sure `redis-server` is installed (per the `Getting started with Redis
 
 Start the Celery worker by running the following command in another terminal::
 
-    $ celery -A config.celery_app worker --loglevel=info
+    $ uv run celery -A config.celery_app worker --loglevel=info
 
 That Celery worker should be running whenever your app is running, typically as a background process,
 so that it can pick up any tasks that get queued. Learn more from the `Celery Workers Guide`_.
 
 The project comes with a simple task for manual testing purposes, inside `<project_slug>/users/tasks.py`. To queue that task locally, start the Django shell, import the task, and call `delay()` on it::
 
-    $ python manage.py shell
+    $ uv run python manage.py shell
     >> from <project_slug>.users.tasks import get_users_count
     >> get_users_count.delay()
 

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = uv run sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 

hooks/post_gen_project.py

@@ -76,7 +76,7 @@ def remove_utility_files():
 
 
 def remove_heroku_files():
-    file_names = ["Procfile", "requirements.txt"]
+    file_names = ["Procfile"]
     for file_name in file_names:
         if file_name == "requirements.txt" and "{{ cookiecutter.ci_tool }}".lower() == "travis":
             # don't remove the file if we are using travisci but not using heroku
@@ -188,20 +188,24 @@ def handle_js_runner(choice, use_docker, use_async):
 
 
 def remove_prettier_pre_commit():
-    pre_commit_yaml = Path(".pre-commit-config.yaml")
-    content = pre_commit_yaml.read_text().splitlines()
+    remove_repo_from_pre_commit_config("mirrors-prettier")
+
+
+def remove_repo_from_pre_commit_config(repo_to_remove: str):
+    pre_commit_config = Path(".pre-commit-config.yaml")
+    content = pre_commit_config.read_text().splitlines(True)
 
     removing = False
     new_lines = []
     for line in content:
         if removing and "- repo:" in line:
             removing = False
-        if "mirrors-prettier" in line:
+        if repo_to_remove in line:
             removing = True
         if not removing:
             new_lines.append(line)
 
-    pre_commit_yaml.write_text("\n".join(new_lines))
+    pre_commit_config.write_text("\n".join(new_lines))
 
 
 def remove_celery_files():
@@ -438,6 +442,7 @@ def main():
 
     if "{{ cookiecutter.use_heroku }}".lower() == "n":
         remove_heroku_files()
+        remove_repo_from_pre_commit_config("uv-pre-commit")
 
     if "{{ cookiecutter.use_docker }}".lower() == "n" and "{{ cookiecutter.use_heroku }}".lower() == "n":
         if "{{ cookiecutter.keep_local_envs_in_vcs }}".lower() == "y":

tests/test_bare.sh

@@ -18,13 +18,13 @@ cd my_awesome_project
 sudo utility/install_os_dependencies.sh install
 
 # Install Python deps
-pip install -r requirements/local.txt
+uv sync
 
 # run the project's tests
-pytest
+uv run pytest
 
 # Make sure the check doesn't raise any warnings
-python manage.py check --fail-level WARNING
+uv run python manage.py check --fail-level WARNING
 
 # Run npm build script if package.json is present
 if [ -f "package.json" ]
@@ -34,4 +34,4 @@ then
 fi
 
 # Generate the HTML for the documentation
-cd docs && make html
+cd docs && uv run make html

tests/test_cookiecutter_generation.py

@@ -2,6 +2,7 @@
 import os
 import re
 import sys
+import tomllib
 from collections.abc import Iterable
 from pathlib import Path
 
@@ -274,7 +275,7 @@ def test_djlint_check_passes(cookies, context_override):
 @pytest.mark.parametrize(
     ("use_docker", "expected_test_script"),
     [
-        ("n", "pytest"),
+        ("n", "uv run pytest"),
         ("y", "docker compose -f docker-compose.local.yml run django pytest"),
     ],
 )
@@ -299,7 +300,7 @@ def test_travis_invokes_pytest(cookies, context, use_docker, expected_test_scrip
 @pytest.mark.parametrize(
     ("use_docker", "expected_test_script"),
     [
-        ("n", "pytest"),
+        ("n", "uv run pytest"),
         ("y", "docker compose -f docker-compose.local.yml run django pytest"),
     ],
 )
@@ -316,7 +317,7 @@ def test_gitlab_invokes_precommit_and_pytest(cookies, context, use_docker, expec
         try:
             gitlab_config = yaml.safe_load(gitlab_yml)
             assert gitlab_config["precommit"]["script"] == [
-                "pre-commit run --show-diff-on-failure --color=always --all-files",
+                "uv run pre-commit run --show-diff-on-failure --color=always --all-files",
             ]
             assert gitlab_config["pytest"]["script"] == [expected_test_script]
         except yaml.YAMLError as e:
@@ -326,7 +327,7 @@ def test_gitlab_invokes_precommit_and_pytest(cookies, context, use_docker, expec
 @pytest.mark.parametrize(
     ("use_docker", "expected_test_script"),
     [
-        ("n", "pytest"),
+        ("n", "uv run pytest"),
         ("y", "docker compose -f docker-compose.local.yml run django pytest"),
     ],
 )
@@ -413,3 +414,39 @@ def test_trim_domain_email(cookies, context):
 
     base_settings = result.project_path / "config" / "settings" / "base.py"
     assert '"me@example.com"' in base_settings.read_text()
+
+
+def test_pyproject_toml(cookies, context):
+    author_name = "Project Author"
+    author_email = "me@example.com"
+    context.update(
+        {
+            "description": "DESCRIPTION",
+            "domain_name": "example.com",
+            "email": author_email,
+            "author_name": author_name,
+        }
+    )
+    result = cookies.bake(extra_context=context)
+    assert result.exit_code == 0
+
+    pyproject_toml = result.project_path / "pyproject.toml"
+
+    data = tomllib.loads(pyproject_toml.read_text())
+
+    assert data
+    assert data["project"]["authors"][0]["email"] == author_email
+    assert data["project"]["authors"][0]["name"] == author_name
+    assert data["project"]["name"] == context["project_slug"]
+
+
+def test_pre_commit_without_heroku(cookies, context):
+    context.update({"use_heroku": "n"})
+    result = cookies.bake(extra_context=context)
+    assert result.exit_code == 0
+
+    pre_commit_config = result.project_path / ".pre-commit-config.yaml"
+
+    data = pre_commit_config.read_text()
+
+    assert "uv-pre-commit" not in data

tests/test_docker.sh

@@ -5,21 +5,38 @@
 
 set -o errexit
 set -x
+set -e
+
+finish() {
+  # Your cleanup code here
+  docker compose -f docker-compose.local.yml down --remove-orphans
+  docker volume rm my_awesome_project_my_awesome_project_local_postgres_data
+
+}
+trap finish EXIT
 
 # create a cache directory
 mkdir -p .cache/docker
 cd .cache/docker
 
+sudo rm -rf my_awesome_project
+
 # create the project using the default settings in cookiecutter.json
 uv run cookiecutter ../../ --no-input --overwrite-if-exists use_docker=y "$@"
 cd my_awesome_project
 
 # make sure all images build
 docker compose -f docker-compose.local.yml build
 
+docker compose -f docker-compose.local.yml run django uv lock
+
+docker compose -f docker-compose.local.yml build
+
 # run the project's type checks
 docker compose -f docker-compose.local.yml run --rm django mypy my_awesome_project
 
+
+
 # run the project's tests
 docker compose -f docker-compose.local.yml run --rm django pytest
 
@@ -44,6 +61,8 @@ docker compose -f docker-compose.local.yml run --rm \
 # Generate the HTML for the documentation
 docker compose -f docker-compose.docs.yml run --rm docs make html
 
+docker build -f ./compose/production/django/Dockerfile .
+
 # Run npm build script if package.json is present
 if [ -f "package.json" ]
 then