Project Modernization

- Migrated setup.py/cfg to pyproject.toml
- Switched mypy to pyproject.toml
- Switched isort/flake8/black to ruff
- Moved version management ot bump-my-version and pyproject.toml
- Updated requirements.txt

Author: ndevenish

.bumpversion.cfg

@@ -1,7 +1,7 @@
 repos:
 # Syntax validation and some basic sanity checks
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.1.0
+  rev: v5.0.0
   hooks:
   - id: check-merge-conflict
   - id: check-ast
@@ -11,40 +11,23 @@ repos:
     args: ['--maxkb=200']
   - id: check-yaml
 
-# Automatically sort imports
-- repo: https://github.com/PyCQA/isort
-  rev: 5.12.0
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.4.8
   hooks:
-  - id: isort
-    args: [
-           '-a', 'from __future__ import annotations',        # 3.7-3.11
-           '--rm', 'from __future__ import absolute_import',  # -3.0
-           '--rm', 'from __future__ import division',         # -3.0
-           '--rm', 'from __future__ import generator_stop',   # -3.7
-           '--rm', 'from __future__ import generators',       # -2.3
-           '--rm', 'from __future__ import nested_scopes',    # -2.2
-           '--rm', 'from __future__ import print_function',   # -3.0
-           '--rm', 'from __future__ import unicode_literals', # -3.0
-           '--rm', 'from __future__ import with_statement',   # -2.6
-          ]
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix, --show-fixes]
+    - id: ruff-format
 
-# Automatic source code formatting
-- repo: https://github.com/psf/black
-  rev: 22.3.0
-  hooks:
-  - id: black
-    args: [--safe, --quiet]
-
-# Linting
-- repo: https://github.com/PyCQA/flake8
-  rev: 4.0.1
-  hooks:
-  - id: flake8
-    additional_dependencies: ['flake8-comprehensions==3.8.0']
+# # Linting
+# - repo: https://github.com/PyCQA/flake8
+#   rev: 7.1.1
+#   hooks:
+#   - id: flake8
+#     additional_dependencies: ['flake8-comprehensions==3.8.0']
 
 # Type checking
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v0.910
+  rev: v1.13.0
   hooks:
   - id: mypy
     files: 'src/.*\.py$'

.mypy.ini

@@ -1,10 +1,91 @@
 [build-system]
-requires = ["setuptools >= 40.6.0", "wheel"]
+requires = ["setuptools>=61.2", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "workflows"
+version = "2.27"
+description = "Data processing in distributed environments"
+readme = "README.rst"
+authors = [
+    { name = "Diamond Light Source", email = "[email protected]" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+license = { text = "BSD-3-Clause" }
+requires-python = ">=3.8"
+dependencies = ["bidict", "pika", "setuptools", "stomp-py>=7"]
+
+[project.urls]
+Download = "https://github.com/DiamondLightSource/python-workflows/releases"
+Documentation = "https://github.com/DiamondLightSource/python-workflows"
+GitHub = "https://github.com/DiamondLightSource/python-workflows"
+Bug-Tracker = "https://github.com/DiamondLightSource/python-workflows/issues"
+
+[project.optional-dependencies]
+prometheus = ["prometheus-client"]
+
+[project.entry-points."libtbx.dispatcher.script"]
+"workflows.validate_recipe" = "workflows.validate_recipe"
+
+[project.entry-points."libtbx.precommit"]
+workflows = "workflows"
+
+[project.entry-points."workflows.services"]
+SampleConsumer = "workflows.services.sample_consumer:SampleConsumer"
+SampleProducer = "workflows.services.sample_producer:SampleProducer"
+SampleTxn = "workflows.services.sample_transaction:SampleTxn"
+SampleTxnProducer = "workflows.services.sample_transaction:SampleTxnProducer"
+
+[project.entry-points."workflows.transport"]
+PikaTransport = "workflows.transport.pika_transport:PikaTransport"
+StompTransport = "workflows.transport.stomp_transport:StompTransport"
+OfflineTransport = "workflows.transport.offline_transport:OfflineTransport"
+
+[project.entry-points."zocalo.configuration.plugins"]
+pika = "workflows.util.zocalo.configuration:Pika"
+stomp = "workflows.util.zocalo.configuration:Stomp"
+transport = "workflows.util.zocalo.configuration:DefaultTransport"
+
+[project.scripts]
+"workflows.validate_recipe" = "workflows.recipe.validate:main"
+
 [tool.isort]
 profile = "black"
 
 [tool.pytest.ini_options]
 addopts = "-ra"
 required_plugins = "pytest-timeout"
+
+[tool.bumpversion]
+current_version = "2.27"
+parse = '(?P<major>\d+)\.(?P<minor>\d+)'
+serialize = ["{major}.{minor}"]
+commit = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "src/workflows/__init__.py"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "C4", "I"]
+unfixable = ["F841"]
+# E501 line too long (handled by formatter)
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["dxtbx_*", "dxtbx"]
+required-imports = ["from __future__ import annotations"]
+
+[tool.mypy]
+mypy_path = "src/"

.pre-commit-config.yaml

@@ -1,9 +1,9 @@
-bidict==0.22.1
-prometheus-client==0.17.0
-pytest==8.2.2
-pytest-cov==5.0.0
-pytest-mock==3.11.1
-pytest-timeout==2.1.0
-setuptools==70.0.0
-stomp.py==8.1.0
+bidict==0.23.1
 pika==1.3.2
+prometheus_client==0.21.0
+pytest==8.3.3
+pytest-cov==6.0.0
+pytest-mock==3.14.0
+pytest-timeout==2.3.1
+stomp-py==8.1.2
+websocket-client==1.8.0

MANIFEST.in

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import sys
-
 from optparse import SUPPRESS_HELP, OptionParser
 
 import workflows

pyproject.toml

@@ -368,7 +368,8 @@ def get_status(self):
 
     def exponential_backoff(self):
         """A function that keeps waiting longer and longer the more rapidly it is called.
-        It can be used to increasingly slow down service starts when they keep failing."""
+        It can be used to increasingly slow down service starts when they keep failing.
+        """
         last_service_switch = self._service_starttime
         if not last_service_switch:
             return