Modernize setup to use pyproject.toml

.circleci/config.yml

@@ -7,28 +7,26 @@ 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
+      - run:
+          name: Install dev dependencies
+          command: make install
       - run:
           name: Test
-          command: |
-            . ~/venv/bin/activate
-            make test
+          command: make test
+          when: always
       - run:
           name: Lint
-          command: |
-            . ~/venv/bin/activate
-            make lint
+          command: make ruff
+          when: always
       - run:
           name: Mypy
-          command: |
-            . ~/venv/bin/activate
-            make mypy
+          command: make mypy
+          when: always
       - run:
-          name: Black
-          command: |
-            . ~/venv/bin/activate
-            make black_check
+          name: Format
+          command: make format_check
+          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

Dockerfile

@@ -29,19 +29,3 @@ FROM base as pytest
 # in.
 ENTRYPOINT ["py.test"]
 CMD [""]
-
-# ---
-
-# Create a isort image from the base
-FROM base as isort
-
-ENTRYPOINT ["isort"]
-CMD ["-rc"]
-
-# ---
-
-# Create a black image from the base
-FROM base as black
-
-ENTRYPOINT ["black"]
-CMD ["."]

docs/xocto/development.md

@@ -24,8 +24,7 @@ Use these make commands:
 
 ```sh
 make lint
-make black
-make isort
+make format
 make mypy
 ```
 
@@ -35,35 +34,37 @@ Docker images for these jobs can be built with:
 make docker_images
 ```
 
-This creates separate images for pytest, isort and black. Each can be run like
-so:
+This creates an image for pytest. Each can be run like so:
 
 ```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:
+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
 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 seperated 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:
+Before you begin, determine the release number. This follows the instructions
+specifiwed on [semver.org](https://semver.org/). Releases therefore use this
+pattern:
 
 ```
 MAJOR.MINOR.PATCH
 ```
 
-Where: 
+Where:
 
 - MAJOR version when you make incompatible API changes
 - MINOR version when you add functionality in a backward compatible manner
@@ -75,9 +76,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,6 +1,6 @@
 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
@@ -10,10 +10,10 @@ clean:
 # Static analysis
 
 lint:
-	make black_check ruff mypy
+	make format_check ruff mypy
 
-black_check:
-	black --check --diff .
+format_check:
+	ruff format --check .
 
 ruff:
 	ruff check .
@@ -26,16 +26,15 @@ test:
 
 format:
 	ruff check --fix .
-	black .
+	ruff format .
 
 docker_images:
 	docker build -t xocto/pytest --target=pytest .
 	docker build -t xocto/ruff --target=ruff .
-	docker build -t xocto/black --target=black .
 
 # Releases
 
-VERSION=v$(shell python setup.py --version)
+VERSION=v$(shell grep -m 1 version pyproject.toml | tr -s ' ' | tr -d '"' | tr -d "'" | cut -d' ' -f3)
 
 tag:
 	@echo Tagging as $(VERSION)

pyproject.toml

@@ -1,5 +1,79 @@
-[tool.black]
-line-length = 99
+[build-system]
+requires = ["setuptools>=68.2.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xocto"
+version = "4.9.0"
+requires-python = ">=3.9"
+description = "Kraken Technologies Python service utilities"
+readme = "README.md"
+authors = [
+  {name = "Kraken Technologies", email = "[email protected]"},
+]
+maintainers = [
+  {name = "Kraken Technologies", email = "[email protected]"},
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Build Tools",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+]
+license = {text = "MIT"}
+dependencies = [
+  "ddtrace>=1.9.0",
+  "duckdb>=0.9.0",
+  "django>=4.0",
+  "openpyxl>=3.1.0",
+  "pact-python>=1.6.0",
+  "pandas>=1.5.3",
+  "pyarrow>=11.0.0",
+  "python-dateutil>=2.8.2",
+  "python-magic>=0.4.27",
+  "pytz",
+  "structlog>=20.2.0",
+  "xlrd>=2.0.1",
+]
+
+[project.optional-dependencies]
+dev = [
+  "boto3==1.26.53",
+  "botocore==1.29.53",
+  "hypothesis==6.62.1",
+  "moto[s3,sqs]==4.1",
+  "mypy-boto3-s3==1.26.0.post1",
+  "mypy==0.991",
+  "numpy==1.22.2",
+  "pre-commit>=3.2.0",
+  "pyarrow-stubs==10.0.1.6",
+  "pytest-django==4.5.2",
+  "pytest-mock==3.10.0",
+  "pytest==7.2.1",  
+  "ruff==0.1.3",
+  "time-machine==2.9.0",
+  "twine==4.0.2",
+  "types-openpyxl==3.0.4.5",
+  "types-python-dateutil==2.8.19.6",
+  "types-pytz==2022.7.1.0",
+  "types-requests==2.28.11.8",
+  "wheel==0.38.4",
+]
+docs = [
+  "Sphinx==4.5.0",
+  "myst-parser==0.18.1",
+]
+
+[project.urls]
+changelog = "https://github.com/octoenergy/xocto/blob/main/CHANGELOG.md"
+documentation = "https://xocto.readthedocs.io"
+issues = "https://github.com/octoenergy/xocto/issues"
+
+[tool.setuptools]
+packages = ["xocto", "xocto.events", "xocto.storage"]
 
 [tool.mypy]
 # Specify which files to check.
@@ -78,7 +152,7 @@ select = [
     "I",  # isort
 ]
 ignore = [
-    "E501",  # line too long - black takes care of this for us
+    "E501",  # line too long 
 ]
 
 [tool.ruff.per-file-ignores]