Preparing for 1.0 release

Run `pre-commit autoupdate`

Run `pre-commit run -a` across all files

Update MANIFEST.in for anyone using setup.py build (not sure if it will be used any more).

Update release instructions in README.rst

.pre-commit-config.yaml

@@ -10,14 +10,14 @@ repos:
       - id: check-yaml
       - id: check-added-large-files
   - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.9.2
+    rev: v5.9.3
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 21.6b0
+    rev: 21.10b0
     hooks:
       - id: black
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.910
+    rev: v0.910-1
     hooks:
       - id: mypy

.tool-versions

@@ -1 +1 @@
-python 3.9.6 3.10.0b3 3.8.7 3.7.9 3.6.12
+python 3.9.6 3.10.0 3.8.7 3.7.9 3.6.12 pypy3.7-7.3.7

MANIFEST.in

@@ -1,2 +1,13 @@
 recursive-include iso8601 *.py
-include README.rst LICENSE tox.ini setup.py *requirements.txt
+recursive-include docs *
+include .editorconfig
+include .envrc
+include .gitignore
+include .pre-commit-config.yaml
+include .tool-versions
+include LICENSE
+include noxfile.py
+include poetry.lock
+include pyproject.toml
+include README.rst
+include setup.py

README.rst

@@ -74,15 +74,27 @@ References
 Testing
 =======
 
-1. poetry install
-2. poetry run nox
+1. `poetry install`
+2. `poetry run nox`
 
 Note that you need all the pythons installed to perform a tox run (see below). pyenv helps hugely, use pyenv install for the versions you need then use 'pyenv local version ...' to link them in (the tox-pyenv plugin will pick them up).
 
 Alternatively, to test only with your current python:
 
-1. poetry install
-2. pytest
+1. `poetry install`
+2. `pytest`
+
+Releasing
+=========
+
+1. Ensure there is a new version committed to main (use `poetry version <action>` to bump).
+2. Ensure README.rst changelog is up to date.
+3. Note new and previous version.
+4. `rm -rf dist`
+5. `poetry build`
+6. `git log --oneline $LAST_RELEASE..@ > git_log.txt`
+7. `gh release create --notes-file git_log.txt --title $NEXT_VERSION $NEXT_VERSION dist/*`
+8. `poetry publish`
 
 Supported Python Versions
 =========================
@@ -93,7 +105,7 @@ Tested against:
 - Python 3.7
 - Python 3.8
 - Python 3.9
-- Python 3.10 (pre-release)
+- Python 3.10
 - PyPy 3
 
 Python 3 versions < 3.6 are untested but should work.