Merge pull request #133 from at-gmbh/feature/add-uv

Add uv as package manager to master

Author: ChrsBaur

CHANGELOG.md

@@ -11,10 +11,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Placeholder for future updates and new features.
 
 
-## [1.1.2] - 2025-03-14
+## [1.2.0] - 2025-04-09
+
+### Added
+- Introduced support for a new package manager `uv` in `cookiecutter.json`, `hooks/post_gen_project.py`, and `README.md`.
+- Added `Dockerfile__uv` for `uv` package manager support.
 
 ### Changed
-- Updated project version from `1.1.1` to `1.1.2` in `pyproject.toml`.
+- Updated project version from `1.1.1` to `1.2.0` in `pyproject.toml`.
 - Updated `ruff` pre-commit hook from `v0.9.10` to `v0.11.0` in `.pre-commit-config.yaml`.
 - Updated `ruff` dependency in `environment-dev.yml` from `>=0.9.7` to `>=0.11.0`.
 - Updated `pytest` from `^8.3.4` to `^8.3.5` in `pyproject.toml`.
@@ -23,6 +27,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated `pytest` from `~8.3` to `~8.3.5` in `requirements-dev.txt`.
 - Updated `wheel` from `~0.37` to `~0.45.1` in `requirements-dev.txt`.
 
+### Documentation
+- Added detailed instructions for using `uv` package manager in `README.md`, including installation, dependency management, running scripts, and testing.
+- Updated the README with new commands for `uv`, `poetry`, and `pip` package managers for running tests, building distribution packages, and setting up pre-commit hooks.
+
+### Fixed
+- Corrected minor formatting issues in the `pyproject.toml` and `README.md`.
+
+### Other
+- Updated `.dockerignore` to include additional directories and files.
+- Updated `docker-compose.yml` to support `uv` package manager.
+- Updated `requirements-dev.txt` for `black`, `pytest`, and `wheel` versions.
+
 ## [1.1.1] - 2025-03-13
 
 ### Changed

cookiecutter.json

@@ -6,7 +6,7 @@
   "project_slug": "{{ cookiecutter.project_name | slugify }}",
   "module_name": "{{ cookiecutter.project_slug | slugify | replace('-', '_') }}",
   "project_short_description": "A short summary of the project",
-  "package_manager": ["conda", "pip", "poetry"],
+  "package_manager": ["conda", "pip", "poetry","uv"],
   "use_notebooks": ["no", "yes"],
   "use_docker": ["no", "yes"],
   "ci_pipeline": ["none", "gitlab"],

hooks/post_gen_project.py

@@ -13,7 +13,9 @@
 
 module_dir = 'src/{{ cookiecutter.module_name }}'
 
-
+files_uv = {
+    'pyproject.toml',
+}
 files_pip = {
     'requirements.txt',
     'requirements-dev.txt',
@@ -33,7 +35,7 @@
     'poetry.toml',
 }
 
-files_package_manager_all = files_pip | files_conda | files_poetry
+files_package_manager_all = files_pip | files_conda | files_poetry | files_uv
 
 files_docker_aux = {
     'docker-compose.yml',
@@ -51,8 +53,11 @@
 files_dockerfile_poetry = {
     'Dockerfile__poetry',
 }
+files_dockerfile_uv = {
+    'Dockerfile__uv',
+}
 
-files_dockerfile_all = files_dockerfile_pip | files_dockerfile_conda | files_dockerfile_poetry
+files_dockerfile_all = files_dockerfile_pip | files_dockerfile_conda | files_dockerfile_poetry | files_dockerfile_uv
 
 files_cli = [
     f'{module_dir}/__main__.py',
@@ -91,6 +96,8 @@ def handle_package_manager():
         _delete_files(files_package_manager_all - files_pip)
     elif package_manager == 'poetry':
         _delete_files(files_package_manager_all - files_poetry)
+    elif package_manager == 'uv':
+        _delete_files(files_package_manager_all - files_uv)
     else:
         print(f"Error: unsupported package manager {package_manager}")
         sys.exit(1)
@@ -117,6 +124,9 @@ def handle_docker():
         elif package_manager == "poetry":
             _delete_files(files_dockerfile_all - files_dockerfile_poetry)
             _rename_files("Dockerfile__poetry", "__poetry", "")
+        elif package_manager == "uv":
+            _delete_files(files_dockerfile_all - files_dockerfile_uv)
+            _rename_files("Dockerfile__uv", "__uv", "")
 
 
 def handle_cli():

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "at-python-template"
-version = "1.1.2"
+version = "1.2.0"
 description = "This is the official Python Project Template of Alexander Thamm GmbH (AT)"
 authors = [
     "Christian Baur <[email protected]>",

pyproject.toml

@@ -1,13 +1,37 @@
+# IDE / Editor config
 .git
-.idea
-.vscode
-build
-dist
-*.egg-info
-venv*
-.venv
-.cache
+.idea/
+.vscode/
+
+# Python build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+pip-wheel-metadata/
+
+# Virtual environments
+.venv/
+venv*/
+env*/
+
+# Python cache
+__pycache__/
+*.py[cod]
+*.so
 .pytest_cache/
-**/__pycache__
+.cache/
+htmlcov/
+
+# Docker-specific
 Dockerfile
-htmlcov
+docker-compose.yml
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Logs and misc
+*.log
+*.tmp
+*.bak
+*.swp

{{cookiecutter.project_slug}}/.dockerignore

@@ -0,0 +1,30 @@
+FROM ghcr.io/astral-sh/uv:python3.11-bookworm AS builder
+
+LABEL maintainer="{{ cookiecutter.company_name if cookiecutter.company_name else cookiecutter.full_name }}"
+
+WORKDIR /app
+
+COPY pyproject.toml uv.lock* ./
+
+RUN uv sync --frozen --no-install-project && uv cache clean
+
+COPY ./src /app/src
+
+RUN uv sync --frozen && uv cache clean
+
+FROM python:3.11-slim-bookworm
+
+WORKDIR /app
+
+COPY --from=builder /app/.venv /app/.venv
+COPY --from=builder /app/src /app/src
+
+COPY ./config /app/config
+
+# Environment variables
+ENV PATH="/app/.venv/bin:$PATH" \
+    PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1
+
+# Run the application
+ENTRYPOINT ["python", "-OO", "-m", "{{ cookiecutter.module_name }}"]