Merge pull request #173 from aodn/4328_setuptools_scm

4328 setuptools scm (DO NOT MERGE)

Author: digorgonzola

.bumpversion.cfg

@@ -1,3 +1,6 @@
+# Ignore the version file, it's created on install
+aodntools/_version.py
+
 # Python files
 *.pyc
 *.egg-info

.gitignore

@@ -16,14 +16,11 @@ RUN apt-get update && \
 RUN add-apt-repository ppa:rael-gc/rvm && apt-get update
 
 RUN apt-get install -y --no-install-recommends \
-    build-essential \
     ca-certificates \
     git \
     libmagic1 \
     libudunits2-dev \
     python3-dev \
-    wget \
-    libffi-dev \
     # Pyenv pre-requisites (from https://github.com/pyenv/pyenv/wiki#suggested-build-environment)
     make build-essential libssl-dev zlib1g-dev \
     libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \
@@ -42,12 +39,13 @@ RUN set -ex \
     && pyenv rehash \
     && chmod -R a+w $PYENV_ROOT/shims
 
-RUN pip install --upgrade pip==22.1.2 setuptools==63.1.0 wheel
+RUN pip install --upgrade pip==22.1.2 setuptools==63.1.0 wheel build
 
 RUN pip install \
     Cython==0.29.30 \
     bump2version==1.0.1 \
-    numpy==1.23.0
+    numpy==1.23.0 \
+    setuptools-scm==7.0.4
 
 RUN useradd --create-home --no-log-init --shell /bin/bash --uid $BUILDER_UID builder
 USER builder

Dockerfile

@@ -34,7 +34,7 @@ pipeline {
                 }
                 stage('package') {
                     steps {
-                        sh 'python setup.py bdist_wheel'
+                        sh 'python -m build -w'
                     }
                 }    
             }

Jenkinsfile

@@ -1 +1,5 @@
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "Unknown/Not Installed"
 __version__ = '0.0.0'

aodntools/__init__.py

@@ -4,9 +4,9 @@ set -euxo pipefail
 
 main() {
   git fetch --prune origin "+refs/tags/*:refs/tags/*"
-  OLD_VERSION=$(git tag -l '*.*.*' --sort=-version:refname | head -n 1)
-  NEW_VERSION=$(bump2version --current-version $OLD_VERSION --list --tag --commit  --allow-dirty patch | grep -oP '^new_version=\K.*$')
-  git push origin tag $NEW_VERSION
+  NEW_VERSION=$(bump2version --current-version $(git describe) --list --no-commit --tag \
+  --tag-message 'Bump version to {new_version}' patch | grep -oP '^new_version=\K.*$')
+  git push origin tag v$NEW_VERSION
 
   exit 0
 }

bumpversion.sh

@@ -0,0 +1,5 @@
+[build-system]
+requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
+
+[tool.setuptools_scm]
+write_to = "aodntools/_version.py"

pyproject.toml

@@ -9,7 +9,8 @@
 ]
 
 TESTS_REQUIRE = [
-    'pytest'
+    'pytest',
+    'setuptools_scm',
 ]
 
 EXTRAS_REQUIRE = {
@@ -26,7 +27,8 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='0.0.0',
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
     packages=find_packages(exclude=PACKAGE_EXCLUDES),
     package_data=PACKAGE_DATA,
     url='https://github.com/aodn',