black: Add black to project

- Adds a new tox `format` command
- Locks black to the last version supporting python 2
- Configures black using pyproject.toml (unfortunately it cannot be
  configured using tox.ini, see psf/black#2172)

Author: evanpurkhiser

.github/workflows/cicd.yml

@@ -49,9 +49,13 @@ jobs:
       uses: actions/setup-python@v5
       with: {python-version: "${{ matrix.python-version }}", cache: pip, cache-dependency-path: 'requirements/*.txt'}
     - name: install tests dependencies
-      run: pip install -r requirements/test.txt -r requirements/lint.txt -r requirements/tox.txt 
+      run: pip install -r requirements/test.txt -r requirements/lint.txt -r requirements/format.txt -r requirements/tox.txt 
     - name: run lint
       run: tox --current-env -e lint
+    - name: run format
+      # Only run the formatting check on the latest python version.
+      if: ${{ matrix.python-version == "3.13" }}
+      run: tox --current-env -e check-format
     - name: run tests with coverage
       run: tox --current-env -e cov
 

README.rst

@@ -340,8 +340,8 @@ Develop this package
     git clone https://github.com/kiorky/croniter.git
     cd croniter
     virtualenv --no-site-packages venv3
-    venv3/bin/pip install --upgrade -r requirements/test.txt -r requirements/lint.txt -r requirements/tox.txt
-    venv3/bin/tox --current-env -e lint,test
+    venv3/bin/pip install --upgrade -r requirements/test.txt -r requirements/lint.txt -r requirements/format.txt -r requirements/tox.txt
+    venv3/bin/tox --current-env -e lint,format,test
 
 
 Testing under py2

pyproject.toml

@@ -0,0 +1,17 @@
+[tool.black]
+line-lenghth = 100
+target-version = [
+  # XXX: This project does still support 2.6, but black does not have a 2.6
+  # target. There should be very few (if any) syntax differences between the
+  # two versions however.
+  'py27',
+  'py34',
+  'py35',
+  'py36',
+  'py37',
+  'py38',
+  'py39',
+  'py310',
+  # Because we're using an old version of black to support older python, there
+  # is no explicit python version target past 3.10
+]

requirements/format.txt

@@ -0,0 +1,8 @@
+# We lock to the version just before black 22, as this is when python 2 support
+# is dropped.
+black==21.11b1
+
+# Lock to an older version of click to fix
+# https://github.com/psf/black/issues/2964. This was fixed in a newever version
+# of black that we cannot use.
+click==8.0.2

tox.ini

@@ -17,3 +17,12 @@ deps = -r{toxinidir}/requirements/lint.txt
 changedir = src
 commands = flake8 croniter/croniter.py
 
+[testenv:check-format]
+deps = -r{toxinidir}/requirements/format.txt
+changedir = src
+commands = black src
+
+[testenv:format]
+deps = -r{toxinidir}/requirements/format.txt
+changedir = src
+commands = black src