Modernize Python repo: pyproject.toml + uv + semantic-release

.github/workflows/ci.yml

@@ -6,33 +6,34 @@ on:
   pull_request:
     branches:
     - '**'
+  workflow_call:
 
 jobs:
   run_tests:
-    name: Tests
+    name: ${{ matrix.toxenv }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     strategy:
       matrix:
         python-version: ['3.12']
-        toxenv: [django42, django52, quality]
+        toxenv: [django42, django52, quality, docs]
 
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-    - name: setup python
-      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+    - name: Setup uv
+      uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
       with:
+        enable-cache: true
         python-version: ${{ matrix.python-version }}
 
-    - name: Install pip
-      run: pip install -r requirements/pip.txt
-
-    - name: Install Dependencies
-      run: pip install -r requirements/ci.txt
+    - name: Install CI dependencies
+      run: uv sync --group ci
 
     - name: Run Tests
       env:
         TOXENV: ${{ matrix.toxenv }}
-      run: tox
+      run: uv run tox
 
     - name: Run Coverage
       if: matrix.python-version == '3.12' && matrix.toxenv == 'django42'
@@ -41,4 +42,3 @@ jobs:
         token: ${{ secrets.CODECOV_TOKEN }}
         flags: unittests
         fail_ci_if_error: true
-

.github/workflows/release.yml

@@ -0,0 +1,95 @@
+name: Semantic Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  run_tests:
+    uses: ./.github/workflows/ci.yml
+    secrets: inherit
+    permissions:
+      contents: read
+
+  release:
+    needs: run_tests
+    if: github.ref_name == 'master'
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-release
+      cancel-in-progress: false
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: Reset to triggered commit
+        run: git reset --hard ${{ github.sha }}
+
+      - name: Python Semantic Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@9a026e9303981c866c3425723009becb2437c757 # v10.6.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions[bot]"
+          git_committer_email: "github-actions[bot]@users.noreply.github.com"
+          changelog: "false"
+          # Commit, tag, push and build, but don't create the GitHub release.
+          # We create it ourselves below so that the distributions are attached
+          # before the release is published (immutable releases require this ordering).
+          vcs_release: "false"
+
+      # This repo has immutable releases enabled, which freezes a release's assets
+      # the moment it is published, so assets cannot be attached afterwards.
+      # Everything we want on the release must be built first and passed to this
+      # one command, which creates the release as a draft, uploads the assets,
+      # and only then publishes it.
+      - name: Create GitHub Release with Assets
+        if: steps.release.outputs.released == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RELEASE_NOTES: ${{ steps.release.outputs.release_notes }}
+          TAG: ${{ steps.release.outputs.tag }}
+        run: |
+          printf '%s' "$RELEASE_NOTES" > "$RUNNER_TEMP/release_notes.md"
+          gh release create "$TAG" \
+            --verify-tag --title "$TAG" \
+            --notes-file "$RUNNER_TEMP/release_notes.md" \
+            dist/*
+
+      - name: Upload dist artifacts
+        if: steps.release.outputs.released == 'true'
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+    outputs:
+      released: ${{ steps.release.outputs.released }}
+      version: ${{ steps.release.outputs.version }}
+
+  publish_to_pypi:
+    needs: release
+    if: needs.release.outputs.released == 'true'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

.gitignore

@@ -24,6 +24,7 @@ pip-log.txt
 
 # Unit test / coverage reports
 .coverage
+coverage.xml
 .tox
 nosetests.xml
 

.readthedocs.yaml

@@ -21,7 +21,10 @@ build:
   tools:
     python: "3.12"
 
-# Optionally set the version of Python and requirements required to build your docs
+# Install doc dependencies from uv.lock using the doc dependency group
 python:
   install:
-  - requirements: requirements/docs.txt
+  - method: uv
+    command: sync
+    groups:
+      - doc

MANIFEST.in

@@ -1,4 +1,9 @@
-include requirements/base.in
 include NOTICE
-include LICENSE
-include requirements/constraints.txt
+
+prune .github
+prune docs
+prune htmlcov
+exclude coverage.xml
+exclude .coverage
+exclude uv.lock
+exclude tox.ini

Makefile

@@ -1,60 +1,44 @@
-.PHONY: docs upgrade test quality install
+.PHONY: docs upgrade test quality install install-test install-dev
 
 REPO_NAME := DoneXBlock
 DOCKER_NAME := donexblock
 
 # For opening files in a browser. Use like: $(BROWSER)relative/path/to/file.html
-BROWSER := python -m webbrowser file://$(CURDIR)/
+BROWSER := uv run python -m webbrowser file://$(CURDIR)/
 
 help: ## display this help message
 	@echo "Please use \`make <target>' where <target> is one of"
 	@awk -F ':.*?## ' '/^[a-zA-Z]/ && NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
 
-install-test:
-	pip install -q -r requirements/test.txt
-
-install-dev:
-	pip install -q -r requirements/dev.txt
-
-install: install-test
-
 quality:  ## Run the quality checks
-	pylint --rcfile=pylintrc done
-	python setup.py -q sdist
-	twine check dist/*
+	uv run pylint --rcfile=pylintrc src/done
+	uv run python -m build --sdist
+	uv run twine check dist/*
 
 test:  ## Run the tests
 	mkdir -p var
 	rm -rf .coverage
-	python -m coverage run --rcfile=.coveragerc  -m pytest
+	uv run python -m coverage run -m pytest
+	uv run python -m coverage xml
 
 covreport:  ## Show the coverage results
-	python -m coverage report -m --skip-covered
-
-upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
-upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
-	pip install -q -r requirements/pip-tools.txt
-	pip install -q -r requirements/pip.txt
-	pip-compile --upgrade --allow-unsafe -o requirements/pip.txt requirements/pip.in
-	pip-compile --upgrade -o requirements/pip-tools.txt requirements/pip-tools.in
-	pip install -q -r requirements/pip.txt
-	pip install -q -r requirements/pip-tools.txt
-	pip-compile --upgrade -o requirements/base.txt requirements/base.in
-	pip-compile --upgrade -o requirements/dev.txt requirements/dev.in
-	pip-compile --upgrade -o requirements/test.txt requirements/test.in
-	pip-compile --upgrade -o requirements/quality.txt requirements/quality.in
-	pip-compile --upgrade -o requirements/tox.txt requirements/tox.in
-	pip-compile --upgrade -o requirements/ci.txt requirements/ci.in
-	pip-compile --upgrade -o requirements/docs.txt requirements/docs.in
-	# lets tox controls the django versions.
-	sed -i.tmp '/^[d|D]jango==/d' requirements/test.txt
-	rm requirements/test.txt.tmp
+	uv run python -m coverage report -m --skip-covered
+
+upgrade: ## update uv.lock and regenerate uv constraint-dependencies
+	uv run --with edx-lint edx_lint write_uv_constraints pyproject.toml
+	uv lock --upgrade
 
 .PHONY: requirements
 requirements: ## install development environment requirements
-	pip install -r requirements/pip.txt
-	pip install -qr requirements/pip-tools.txt
-	pip install -r requirements/dev.txt
+	uv sync --group dev
+
+install-test: ## install test dependencies
+	uv sync --group test
+
+install-dev: ## install development dependencies
+	uv sync --group dev
+
+install: install-test ## install default (test) dependencies
 
 dev.clean:
 	-docker rm $(DOCKER_NAME)-dev
@@ -68,7 +52,7 @@ dev.run: dev.clean dev.build ## Clean, build and run test image
 
 ## Localization targets
 
-WORKING_DIR := done
+WORKING_DIR := src/done
 EXTRACT_DIR := $(WORKING_DIR)/conf/locale/en/LC_MESSAGES
 EXTRACTED_DJANGO := $(EXTRACT_DIR)/django-partial.po
 EXTRACTED_TEXT := $(EXTRACT_DIR)/django.po

docs/source/conf.py

@@ -13,17 +13,16 @@
 import os
 import sys
 from datetime import datetime
+from importlib.metadata import version as get_version
 
-sys.path.insert(0, os.path.abspath('../..'))
-
-import done
+sys.path.insert(0, os.path.abspath('../../src'))
 
 # -- Project information -----------------------------------------------------
 
 project = 'DoneXBlock'
 current_year = datetime.utcnow().year
 copyright = f'{current_year}, Axim Collaborative'
-version = done.__version__
+version = get_version("done-xblock")
 
 
 # -- General configuration ---------------------------------------------------