Merge branch 'main' into update-pre-commit

Author: JacobCoffee

.coveragerc

@@ -0,0 +1,5 @@
+# Ruff linting and formatting (#2882)
+2cf268f0c3b35973cfb6d5bbcfec5de09954eae7
+
+# Move apps under apps/ namespace and update all imports (#2883)
+31bc7e3698333333397292dc01d88e61e41761ab

.git-blame-ignore-revs

@@ -28,11 +28,11 @@ jobs:
         uses: actions/cache@v5
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('*-requirements.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
           restore-keys: ${{ runner.os }}-pip-
 
       - name: Install dependencies
-        run: pip install -r dev-requirements.txt
+        run: pip install -e '.[dev]'
 
       - name: Check for ungenerated migrations
         run: python manage.py makemigrations --check --dry-run
@@ -78,13 +78,13 @@ jobs:
         uses: actions/cache@v5
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt', '*-requirements.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
           restore-keys: ${{ runner.os }}-pip-
 
       - name: Install dependencies
         run: |
           pip install -U pip setuptools wheel
-          pip install -r dev-requirements.txt
+          pip install -e '.[dev]'
 
       - name: Run tests
         run: python -Wd -m coverage run manage.py test -v2

.github/workflows/ci.yml

@@ -19,15 +19,15 @@ jobs:
           cache-name: pythondotorg-cache-pip
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-${{ github.job }}-${{ env.cache-name }}-${{ hashFiles('requirements.txt', '*-requirements.txt') }}
+          key: ${{ runner.os }}-${{ github.job }}-${{ env.cache-name }}-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-${{ github.job }}-${{ env.cache-name }}-
             ${{ runner.os }}-${{ github.job }}-
             ${{ runner.os }}-
       - name: Install Python dependencies
         run: |
           pip install -U pip setuptools wheel
-          pip install -r requirements.txt -r prod-requirements.txt
+          pip install '.[prod]'
       - name: Run Tests
         run: |
           DJANGO_SETTINGS_MODULE=pydotorg.settings.static python manage.py collectstatic --noinput

.github/workflows/static.yml

@@ -1,4 +1,11 @@
 repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
   - repo: https://github.com/adamchainz/django-upgrade
     rev: 1.29.1
     hooks:

.pre-commit-config.yaml

@@ -10,6 +10,6 @@ build:
     python: "3"
 
   commands:
-      - python -m pip install -r docs-requirements.txt
+      - python -m pip install '.[docs]'
       - make -C docs html JOBS=$(nproc) BUILDDIR=_readthedocs
       - mv docs/_readthedocs _readthedocs

.readthedocs.yaml

@@ -32,17 +32,16 @@ RUN case $(uname -m) in \
 RUN mkdir /code
 WORKDIR /code
 
-COPY dev-requirements.txt /code/
-COPY base-requirements.txt /code/
-COPY prod-requirements.txt /code/
-COPY requirements.txt /code/
-
 RUN pip --no-cache-dir --disable-pip-version-check install --upgrade pip setuptools wheel
 
+COPY pyproject.toml /code/
+
 RUN --mount=type=cache,target=/root/.cache/pip \
     set -x \
     && pip --disable-pip-version-check \
         install \
-        -r dev-requirements.txt
+        '.[dev]'
 
 COPY . /code/
+
+RUN pip --disable-pip-version-check install --no-deps -e '.'

Dockerfile

@@ -33,17 +33,17 @@ RUN case $(uname -m) in \
 RUN mkdir /code
 WORKDIR /code
 
-COPY dev-requirements.txt /code/
-COPY base-requirements.txt /code/
-COPY prod-requirements.txt /code/
-COPY requirements.txt /code/
-
 RUN pip --no-cache-dir --disable-pip-version-check install --upgrade pip setuptools wheel
 
+COPY pyproject.toml /code/
+
 RUN --mount=type=cache,target=/root/.cache/pip \
     set -x \
     && pip --disable-pip-version-check \
         install \
-        -r requirements.txt -r prod-requirements.txt
+        '.[prod]'
+
 COPY . /code/
+
+RUN pip --disable-pip-version-check install --no-deps '.'
 RUN DJANGO_SETTINGS_MODULE=pydotorg.settings.static python manage.py collectstatic --noinput

Dockerfile.cabotage

@@ -1,56 +1,90 @@
-help:
-	@echo "Call a specific subcommand:"
-	@echo
-	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
-		| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
-	@echo
+.DEFAULT_GOAL := help
 
-default: help
+help: ## Display this help text
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
-.state/docker-build-web: Dockerfile dev-requirements.txt base-requirements.txt
-	# Build web container for this project
-	docker compose build --force-rm web
+# =============================================================================
+# Docker State
+# =============================================================================
 
-	# Mark the state so we don't rebuild this needlessly.
+.state/docker-build-web: Dockerfile pyproject.toml
+	docker compose build --force-rm web
 	mkdir -p .state && touch .state/docker-build-web
 
 .state/db-migrated:
-	# Call migrate target
-	make migrate 
-
-	# Mark the state so we don't rebuild this needlessly.
+	make migrate
 	mkdir -p .state && touch .state/db-migrated
 
 .state/db-initialized: .state/docker-build-web .state/db-migrated
-	# Load all fixtures
 	docker compose run --rm web ./manage.py loaddata fixtures/*.json
-
-	# Mark the state so we don't rebuild this needlessly.
 	mkdir -p .state && touch .state/db-initialized
 
+# =============================================================================
+# Development
+# =============================================================================
+
+##@ Development
+
 serve: .state/db-initialized ## Start the application
 	docker compose up --remove-orphans
 
 migrations: .state/db-initialized ## Generate migrations from models
-	docker compose run --rm web ./manage.py makemigrations  
-	
+	docker compose run --rm web ./manage.py makemigrations
+
 migrate: .state/docker-build-web ## Run Django migrate
-	docker compose run --rm web ./manage.py migrate 
+	docker compose run --rm web ./manage.py migrate
 
-manage: .state/db-initialized ## Run Django manage to accept arbitrary arguments
+manage: .state/db-initialized ## Run arbitrary manage.py commands
 	docker compose run --rm web ./manage.py $(filter-out $@,$(MAKECMDGOALS))
 
 shell: .state/db-initialized ## Open Django interactive shell
 	docker compose run --rm web ./manage.py shell
 
+docker_shell: .state/db-initialized ## Open bash in web container
+	docker compose run --rm web /bin/bash
+
 clean: ## Clean up the environment
 	docker compose down -v
-	rm -f .state/docker-build-web .state/db-initialized .state/db-migrated 
+	rm -f .state/docker-build-web .state/db-initialized .state/db-migrated
+
+# =============================================================================
+# Code Quality
+# =============================================================================
 
-test: .state/db-initialized ## Run tests
+##@ Code Quality
+
+lint: ## Run ruff linter (--fix enabled)
+	@if command -v ruff >/dev/null 2>&1; then ruff check --fix .; else docker compose run --rm web ruff check --fix .; fi
+
+fmt: ## Run ruff formatter
+	@if command -v ruff >/dev/null 2>&1; then ruff format .; else docker compose run --rm web ruff format .; fi
+
+test: .state/db-initialized ## Run test suite
 	docker compose run --rm web ./manage.py test
 
-docker_shell: .state/db-initialized ## Open a bash shell in the web container
-	docker compose run --rm web /bin/bash
+ci: lint fmt test ## Run lint, fmt, then tests
+
+# =============================================================================
+# Documentation
+# =============================================================================
+
+##@ Documentation
+
+docs: docs-clean ## Build documentation
+	@echo "=> Building documentation"
+	@uv sync --group docs
+	@uv run sphinx-build -M html docs/source docs/_build/ -E -a -j auto --keep-going
+
+docs-serve: docs-clean ## Serve documentation with live reload
+	@echo "=> Serving documentation"
+	@uv sync --group docs
+	@uv run sphinx-autobuild docs/source docs/_build/ -j auto --port 0
+
+docs-clean: ## Clean built documentation
+	@echo "=> Cleaning documentation build assets"
+	@rm -rf docs/_build
+	@echo "=> Removed existing documentation build assets"
 
-.PHONY: help serve migrations migrate manage shell clean test docker_shell
+.PHONY: help serve migrations migrate manage shell docker_shell clean
+.PHONY: lint fmt test ci
+.PHONY: docs docs-serve docs-clean

Makefile

@@ -3,22 +3,37 @@
 [![CI](https://github.com/python/pythondotorg/actions/workflows/ci.yml/badge.svg)](https://github.com/python/pythondotorg/actions/workflows/ci.yml)
 [![Documentation Status](https://readthedocs.org/projects/pythondotorg/badge/?version=latest)](https://pythondotorg.readthedocs.io/?badge=latest)
 
-### General information
-
-This is the repository and issue tracker for [python.org](https://www.python.org). 
+The codebase behind [python.org](https://www.python.org). Built with Django, PostgreSQL, Redis, and Celery.
 
 > [!NOTE]
-> The repository for CPython itself is at https://github.com/python/cpython, and the 
-> issue tracker is at https://github.com/python/cpython/issues/. 
-> 
+> The repository for CPython itself is at https://github.com/python/cpython, and the
+> issue tracker is at https://github.com/python/cpython/issues/.
+>
 > Similarly, issues related to [Python's documentation](https://docs.python.org) can be filed in
 > https://github.com/python/cpython/issues/.
 
+### Quick start
+
+```bash
+make serve
+```
+
+Then visit http://localhost:8000. See the [full setup docs](https://pythondotorg.readthedocs.io/en/latest/install.html) for prerequisites.
+
 ### Contributing
 
-* Source code: https://github.com/python/pythondotorg
-* Issue tracker: https://github.com/python/pythondotorg/issues
-* Documentation: https://pythondotorg.readthedocs.io/
-* Mailing list: [pydotorg-www](https://mail.python.org/mailman/listinfo/pydotorg-www)
-* IRC: `#pydotorg` on Freenode
-* License: Apache License
+Fork the repo, create a branch, and open a pull request. Before submitting:
+
+- Run `make test` and make sure the suite passes
+- Run `make lint` and `make fmt`
+- Write tests for any new or changed code
+- Check for missing migrations with `make migrations`
+
+CI runs on every PR — it checks for ungenerated migrations and enforces a 75%
+test coverage minimum. PRs that fail CI won't be merged.
+
+See the full [contributing guide](https://pythondotorg.readthedocs.io/en/latest/contributing.html) for details.
+
+### License
+
+Apache License