Merge pull request #1 from lambda-science/master

Initial Commit

Author: lambda-science

.gitignore

@@ -172,3 +172,15 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+# Boiletplate
+venv/
+env/
+.env/
+.venv/
+.ruff_cache/
+**/.pytest_cache/
+**/__pycache__/
+dist/
+.coverage
+

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.10
+    hooks:
+      - id: ruff-check
+        args: [ --fix, --config=pyproject.toml ]
+      - id: ruff-format
+        args: [ --config=pyproject.toml ]

.python-version

@@ -0,0 +1 @@
+3.13

Dockerfile

@@ -0,0 +1,24 @@
+FROM python:3.13-slim-bullseye
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_NO_CACHE=1
+
+RUN apt update && \
+    apt install -y --no-install-recommends \
+    build-essential \
+    cmake \
+    curl \
+    gcc \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+COPY README.md /app/
+COPY pyproject.toml /app/
+RUN uv sync --no-install-project --no-dev
+COPY src/modern_python_boilerplate /app/modern_python_boilerplate
+
+EXPOSE 8000
+
+CMD ["uv", "run", "modern_python_boilerplate/main.py"]

Makefile

@@ -0,0 +1,44 @@
+dev:
+	modern_python_boilerplate
+
+prod:
+	modern_python_boilerplate
+
+test:
+	uv run pytest tests/
+
+cov:
+	uv run pytest --cov=src/modern_python_boilerplate tests/ --cov-report=term-missing
+
+check:
+	uv run ruff check $$(git diff --name-only --cached -- '*.py')
+
+format:
+	uv run ruff format $$(git diff --name-only --cached -- '*.py')
+
+type:
+	uv run ty check $$(git diff --name-only --cached -- '*.py')
+
+doc:
+	uvx --with mkdocstrings  --with mkdocs-material --with mkdocstrings-python --with mkdocs-include-markdown-plugin mkdocs serve
+
+build:
+	uv build
+
+publish:
+	uv publish
+
+commit:
+	pre-commit
+
+dockerbuild:
+	docker build -t modern-python-boilerplate:latest .
+
+dockerrun:
+	docker run --rm modern-python-boilerplate:latest
+
+allci:
+	$(MAKE) check
+	$(MAKE) format
+	$(MAKE) type
+	$(MAKE) cov

README.md

@@ -0,0 +1,57 @@
+[project]
+name = "modern-python-boilerplate"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+authors = [
+    { name = "Corentin Meyer", email = "[email protected]" },
+]
+maintainers = [
+    { name = "Corentin Meyer", email = "[email protected]" }
+]
+dependencies = []
+
+[project.urls]
+Homepage = ""
+Documentation = ""
+Repository = ""
+Issues = ""
+
+[dependency-groups]
+dev = [
+    "ruff",
+    "pytest",
+    "pytest-cov",
+    "ty",
+    "twine",
+    "build",
+    "pre-commit",
+    "rich",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/modern_python_boilerplate"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.scripts]
+modern_python_boilerplate = "modern_python_boilerplate.main:hello_world"
+
+[tool.ruff]
+target-version = "py313"
+include = ["src/**/*.py"]
+exclude = [
+    "scripts"
+]
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "T201"]
+
+[tool.coverage.run]
+omit = ["tests/*"]

pyproject.toml

@@ -0,0 +1,6 @@
+def hello_world():
+    return "Hello from modern-python-boilerplate!"
+
+
+if __name__ == "__main__":
+    hello_world()

src/modern_python_boilerplate/__init__.py

@@ -0,0 +1,7 @@
+from modern_python_boilerplate.main import hello_world
+
+
+def test_hello_world():
+    """Test that hello_world prints the expected message."""
+    output = hello_world()
+    assert output == "Hello from modern-python-boilerplate!"