maintain version number in __init__.py

Author: kshepherd

MAINTAINING.md

@@ -7,12 +7,9 @@ These notes are for maintenance of the Git / PyPI source and releases / versions
 All the tasks we need to do, in order, when releasing a new version:
 
 1. **Check the main branch!** - we should have all the changes we want to include merged/picked and tested
-2. **Update setup.py** - this might include other dependency or project description changes, but usually will just be a case of incrementing the version number, e.g. `0.1.9` -> `0.1.10`. Note the new number.
-3. **Update publish.sh** - this simple publish script performs the publish to PyPI and will need the new version number
-4. **Update CHANGELOG.md** - new versions go at the top of the file. See previous release blocks for formatting. I include a 'thanks' or 'reported by' attribution for PRs contributed or issues reported. The new version number from `setup.py` is used for the heading and the (future) PyPI URL
+2. **Update version number** - edit `dspace_rest_client/__init__.py` and update the version. Usually, this will just be a case of incrementing the version number, e.g. `0.1.9` -> `0.1.10`.
+3. **Update CHANGELOG.md** - new versions go at the top of the file. See previous release blocks for formatting. I include a 'thanks' or 'reported by' attribution for PRs contributed or issues reported. The new version number is used for the heading and the (future) PyPI URL
 4. **Commit release preparation** - once you are happy with the steps above, commit with a message like 'Prepare release 0.1.10'
 5. **Push branch** - making sure github is up to date, (in future: CI)
 6. **Clear out build and dist directories**: OPTIONAL, but nice to start with a clean Python build environment before making this new version
-7. **Run publish script** - this will run `setup.py` to build a new version then upload to PyPI with twine - you will need an API token and publish access in PyPI to do this.
-
-TODO: If we just keep a `version` file around or base builds on a version number extracted from tag name, some of these steps can be more easily automated or derived instead of updated by hand, but for now it's all pretty simple.
+7. **Run publish script** - with version number as an argument, e.g. `./publish.sh 0.1.10`. This will run `setup.py` to build a new version then upload to PyPI with twine - you will need an API token and publish access in PyPI to do this.

dspace_rest_client/__init__.py

@@ -1 +1,2 @@
 from . import *
+__version__ = '0.1.12'

publish.sh

@@ -1,3 +1,24 @@
 #!/bin/bash
-python setup.py bdist_wheel
-twine upload --repository dspace-rest-client dist/dspace_rest_client-0.1.12-py3-none-any.whl
+
+version=$1
+
+if ! [[ $version =~ ^[0-9]+\.+[0-9]+\.[0-9]+$ ]]; then
+  echo "Usage: publish.sh <version>"
+  echo "Version must match the form x.y.z where all parts are numbers e.g. 0.1.13"
+  exit 1
+fi
+
+echo "Building dspace_rest_client version ${version}"
+if ! python setup.py bdist_wheel; then
+  echo "Error: Failed to build the package"
+  exit 1
+fi
+
+echo "Uploading dspace_rest_client version ${version}"
+if ! twine upload --repository dspace-rest-client dist/dspace_rest_client-0.1.13-py3-none-any.whl; then
+  echo "Error: Failed to upload to PyPI"
+  exit 1
+fi
+
+echo "...done"
+exit 0

setup.py

@@ -1,11 +1,12 @@
 import setuptools
+from dspace_rest_client import __version__
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setuptools.setup(
     name="dspace-rest-client",
-    version="0.1.12",
+    version=__version__,
     author="Kim Shepherd",
     author_email="[email protected]",
     description="A DSpace 7 REST API client library",