maint: include __version__, add RELEASE.md, use tbump

Author: consideRatio

MANIFEST.in

@@ -1,3 +1,2 @@
 include *.md
 include LICENSE
-include version.py

RELEASE.md

@@ -0,0 +1,60 @@
+# How to make a release
+
+`batchspawner` is a package available on [PyPI] and on [conda-forge].
+
+These are the instructions on how to make a release.
+
+## Pre-requisites
+
+- Push rights to this GitHub repository
+
+## Steps to make a release
+
+1. Create a PR updating `CHANGELOG.md` with [github-activity] and continue when
+   its merged.
+
+   Advice on this procedure can be found in [this team compass
+   issue](https://github.com/jupyterhub/team-compass/issues/563).
+
+2. Checkout main and make sure it is up to date.
+
+   ```shell
+   git checkout main
+   git fetch origin main
+   git reset --hard origin/main
+   ```
+
+3. Update the version, make commits, and push a git tag with `tbump`.
+
+   ```shell
+   pip install tbump
+   ```
+
+   `tbump` will ask for confirmation before doing anything.
+
+   ```shell
+   # Example versions to set: 1.0.0, 1.0.0b1
+   VERSION=
+   tbump ${VERSION}
+   ```
+
+   Following this, the [CI system] will build and publish a release.
+
+4. Reset the version back to dev, e.g. `1.0.1.dev` after releasing `1.0.0`.
+
+   ```shell
+   # Example version to set: 1.0.1.dev
+   NEXT_VERSION=
+   tbump --no-tag ${NEXT_VERSION}.dev
+   ```
+
+5. Following the release to PyPI, an automated PR should arrive within 24 hours
+   to [conda-forge/batchspawner-feedstock] with instructions on releasing to
+   conda-forge. You are welcome to volunteer doing this, but aren't required as
+   part of making this release to PyPI.
+
+[github-activity]: https://github.com/executablebooks/github-activity
+[pypi]: https://pypi.org/project/batchspawner/
+[ci system]: https://github.com/jupyterhub/batchspawner/actions/workflows/release.yaml
+[conda-forge]: https://anaconda.org/conda-forge/batchspawner
+[conda-forge/batchspawner-feedstock]: https://github.com/conda-forge/batchspawner-feedstock

batchspawner/__init__.py

@@ -1,2 +1,3 @@
 from .batchspawner import *
+from ._version import __version__, version_info
 from . import api

batchspawner/_version.py

@@ -0,0 +1,7 @@
+# __version__ should be updated using tbump, based on configuration in
+# pyproject.toml, according to instructions in RELEASE.md.
+#
+__version__ = "1.3.0.dev"
+
+# version_info looks like (1, 2, 3, "dev") if __version__ is 1.2.3.dev
+version_info = tuple(int(p) if p.isdigit() else p for p in __version__.split("."))

pyproject.toml

@@ -1,3 +1,35 @@
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
+
+
+# tbump is used to simplify and standardize the release process when updating
+# the version, making a git commit and tag, and pushing changes.
+#
+# ref: https://github.com/your-tools/tbump#readme
+#
+[tool.tbump]
+github_url = "https://github.com/jupyterhub/tmpauthenticator"
+
+[tool.tbump.version]
+current = "1.3.0.dev"
+regex = '''
+    (?P<major>\d+)
+    \.
+    (?P<minor>\d+)
+    \.
+    (?P<patch>\d+)
+    (?P<pre>((a|b|rc)\d+)|)
+    \.?
+    (?P<dev>(?<=\.)dev\d*|)
+'''
+
+[tool.tbump.git]
+message_template = "Bump to {new_version}"
+tag_template = "v{new_version}"
+
+[[tool.tbump.file]]
+src = "setup.py"
+
+[[tool.tbump.file]]
+src = "batchspawner/_version.py"

setup.py

@@ -3,18 +3,13 @@
 with open("README.md") as f:
     long_description = f.read()
 
-# Get the current package version.
-version_ns = {}
-with open("version.py") as f:
-    exec(f.read(), {}, version_ns)
-
 setup(
     name="batchspawner",
     entry_points={
         "console_scripts": ["batchspawner-singleuser=batchspawner.singleuser:main"],
     },
     packages=["batchspawner"],
-    version=version_ns["__version__"],
+    version="1.3.0.dev",
     description="""Batchspawner: A spawner for Jupyterhub to spawn notebooks using batch resource managers.""",
     long_description=long_description,
     long_description_content_type="text/markdown",