Modernize setup to use pyproject.toml

.circleci/config.yml

@@ -7,28 +7,35 @@ jobs:
     steps:
       - checkout
       - run:
-          name: Install dev dependencies
+          name: Create virtualenv
           command: |
-            python3 -m venv ~/venv
-            . ~/venv/bin/activate
-            make install
+            python -m venv /home/circleci/venv/
+            echo "source /home/circleci/venv/bin/activate" >> $BASH_ENV
+      - restore_cache:
+          keys:
+            - &cache-key python-3.9-packages-v1-{{ checksum "pyproject.toml" }}
+            - &cache-key-prefix python-3.9-packages-v1-
       - run:
-          name: Test
-          command: |
-            . ~/venv/bin/activate
-            make test
+          name: Install dev dependencies
+          command: make install
+      - save_cache:
+          key: *cache-key
+          paths:
+            - "/home/circleci/venv/"
+            - "/home/circleci/.cache/pip"
       - run:
-          name: Lint
-          command: |
-            . ~/venv/bin/activate
-            make lint
+          name: Check formatting
+          command: make format_check
+          when: always
       - run:
-          name: Mypy
-          command: |
-            . ~/venv/bin/activate
-            make mypy
+          name: Check linting
+          command: make lint_check
+          when: always
       - run:
-          name: Black
-          command: |
-            . ~/venv/bin/activate
-            make black_check
+          name: Run tests
+          command: make test
+          when: always
+      - run:
+          name: Check Python type annotations
+          command: make mypy
+          when: always

.pre-commit-config.yaml

@@ -16,22 +16,6 @@ repos:
         stages: [commit]
       - id: trailing-whitespace      # Trims trailing whitespace.
 
-
-  - repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-
-  - repo: https://github.com/ambv/black
-    rev: 23.1.0
-    hooks:
-      - id: black
-
-  - repo: https://github.com/pycqa/flake8.git
-    rev: 6.0.0
-    hooks:
-    - id: flake8
-
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: 'v1.1.1'
     hooks:

.readthedocs.yaml

@@ -6,18 +6,17 @@
 version: 2
 
 # Set the version of Python
+# and use modern dependency management
 build:
   os: ubuntu-22.04
   apt_packages:
     - libmagic1
   tools:
     python: "3.10"
+  jobs:
+    pre_build:
+      - "pip install '.[docs]'"
 
 # Build documentation in the docs/ directory
 sphinx:
-  configuration: docs/conf.py
-
-# Declare the Python requirements required to build the docs
-python:
-  install:
-    - requirements: docs/requirements.txt
+  configuration: docs/conf.py

docs/xocto/development.md

@@ -1,5 +1,7 @@
 # Development
 
+This page details how to develop `xocto`.
+
 ## Installation of development environment
 
 Create and activate a Python 3.9 virtualenv then run:
@@ -8,7 +10,7 @@ Create and activate a Python 3.9 virtualenv then run:
 make install
 ```
 
-to install the package including development and testing dependencies
+to install the package including development and testing dependencies.
 
 ## Running tests
 
@@ -23,49 +25,41 @@ make test
 Use these make commands:
 
 ```sh
-make lint
-make black
-make isort
-make mypy
+make format_check  # Check formatting
+make lint_check    # Check linting
+make mypy          # Check Python type annotations
 ```
 
-Docker images for these jobs can be built with:
+## Coding conventions
 
-```sh
-make docker_images
-```
+### Don't mix code changes with version updates
 
-This creates separate images for pytest, isort and black. Each can be run like
-so:
+Code changes mixed with version updates are problematic. The reason is because
+of this workflow:
 
-```sh
-docker run -v `pwd`:/opt/app xocto/pytest
-docker run -v `pwd`:/opt/app xocto/isort
-docker run -v `pwd`:/opt/app xocto/black
-```
-
-## Don't mix code changes with version updates
-
-Code changes mixed with version updates are problematic. The reason is because of this workflow:
-
-1. I write a bugfix PR that also updates the version
+1. I write a bug-fix PR that also updates the version
 2. You add a feature PR that also updates the version
 3. Everyone else mixes version changes with their code change PRs
-4. My PR is accepted, now everyone else has to update the version specified in their PR
+4. My PR is accepted, now everyone else has to update the version specified in
+   their PR
 
-This is why typically in shared projects version releases are seperated into their own pull requests.
+This is why typically in shared projects version releases are separated into
+their own pull requests.
 
 ## Publishing
 
-Before you begin, determine the release number. This follows the instructions specifiwed on [semver.org](https://semver.org/). Releases therefore use this pattern:
+### Version number
+
+First determine the version number. Follow the instructions specified on
+[semver.org](https://semver.org/) which advocates this pattern:
 
 ```
 MAJOR.MINOR.PATCH
 ```
 
-Where: 
+where:
 
-- MAJOR version when you make incompatible API changes
+- MAJOR version when you make backwards-incompatible API changes
 - MINOR version when you add functionality in a backward compatible manner
 - PATCH version when you make backward compatible bug fixes
 
@@ -75,9 +69,10 @@ Create a pull request that:
 
 1. Adds release notes to `CHANGELOG.md`.
 
-2. Updates the `VERSION` constant in `setup.py`.
+2. Updates the `VERSION` constant in `pyproject.toml`.
 
-3. Updates the `__version__` constant in `xocto/__init__.py`, following the [semver.org](https://semver.org/) specification.
+3. Updates the `__version__` constant in `xocto/__init__.py`, following the
+   [semver.org](https://semver.org/) specification.
 
 Commit these changes in a single commit with subject matching
 `Bump version to v...`.

makefile

@@ -1,41 +1,39 @@
 install: 
-	pip install pip==23.1.2
-	pip install -e .[dev,test]
+	pip install pip==23.3.1
+	pip install -e '.[dev,docs]'
 
-clean:
-	@echo Cleaning workspace
-	-rm -rf dist/ *.egg-info/ build/
-	-find . -type d -name __pycache__ -delete
 
-# Static analysis
+# CI step wrappers
 
-lint:
-	make black_check ruff mypy
+ci: format_check lint_check test mypy
 
-black_check:
-	black --check --diff .
+format_check:
+	ruff format --check .
 
-ruff:
+lint_check:
 	ruff check .
 
+test:
+	py.test
+
 mypy:
 	mypy
 
-test:
-	py.test
+# Local helpers
+
+clean:
+	@echo Cleaning workspace
+	-rm -rf dist/ *.egg-info/ build/
+	-find . -type d -name __pycache__ -delete
 
 format:
 	ruff check --fix .
-	black .
-
-docker_images:
-	docker build -t xocto/pytest --target=pytest .
-	docker build -t xocto/ruff --target=ruff .
-	docker build -t xocto/black --target=black .
+	ruff format .
 
 # Releases
 
-VERSION=v$(shell python setup.py --version)
+# Extract version from pyproject.toml
+VERSION=$(shell python -c "import importlib.metadata; print(importlib.metadata.version('xocto'))")
 
 tag:
 	@echo Tagging as $(VERSION)