[patch] Introduce automatic versioning

.github/workflows/python-package.yml

@@ -1,61 +1,63 @@
-name: Python Package
-
+name: Build Python Package
 on:
  push:
- branches: [ "*" ]
-
+ branches: [ "**" ]
+ tags-ignore: [ "**" ]
 jobs:
- build:
+ build-package:
  runs-on: ubuntu-latest
- strategy:
- fail-fast: false
- matrix:
- python-version: ["3.9", "3.10", "3.11"]
- primary-config: ["true", "false"]
- # There may be a better way to do this, but it was the first way I found to set a variable for specific matrix entry
- exclude:
- - python-version: "3.9"
- primary-config: "true"
- - python-version: "3.10"
- primary-config: "true"
- - python-version: "3.11"
- primary-config: "false"
  steps:
- - uses: actions/checkout@v4
- - name: Set up Python ${{ matrix.python-version }}
- uses: actions/setup-python@v3
- with:
- python-version: ${{ matrix.python-version }}
- - name: Install
- run: |
- python -m pip install --upgrade pip
- python -m pip install .[dev] flake8
- - name: Lint with flake8
- run: |
- # stop the build if there are Python syntax errors or undefined names
- flake8 src --count --select=E9,F63,F7,F82 --show-source --statistics
- # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
- flake8 src --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- - name: Test with pytest (only on Python 3.11 to avoid concurrency issues)
- if: ${{ (github.ref == 'refs/heads/master') && (matrix.primary-config == 'true') }}
- env:
- ONE_JOB_ONLY_TESTS: ${{ matrix.primary-config }}
- WIOTP_API_KEY: ${{ secrets.WIOTP_API_KEY }}
- WIOTP_API_TOKEN: ${{ secrets.WIOTP_API_TOKEN }}
- WIOTP_ORG_ID: ${{ secrets.WIOTP_ORG_ID }}
- CLOUDANT_HOST: ${{ secrets.CLOUDANT_HOST }}
- CLOUDANT_PORT: ${{ secrets.CLOUDANT_PORT }}
- CLOUDANT_USERNAME: ${{ secrets.CLOUDANT_USERNAME }}
- CLOUDANT_PASSWORD: ${{ secrets.CLOUDANT_PASSWORD }}
- EVENTSTREAMS_API_KEY: ${{ secrets.EVENTSTREAMS_API_KEY }}
- EVENTSTREAMS_ADMIN_URL: ${{ secrets.EVENTSTREAMS_ADMIN_URL }}
- EVENTSTREAMS_BROKER1: ${{ secrets.EVENTSTREAMS_BROKER1 }}
- EVENTSTREAMS_BROKER2: ${{ secrets.EVENTSTREAMS_BROKER2 }}
- EVENTSTREAMS_BROKER3: ${{ secrets.EVENTSTREAMS_BROKER3 }}
- EVENTSTREAMS_BROKER4: ${{ secrets.EVENTSTREAMS_BROKER4 }}
- EVENTSTREAMS_BROKER5: ${{ secrets.EVENTSTREAMS_BROKER5 }}
- EVENTSTREAMS_BROKER6: ${{ secrets.EVENTSTREAMS_BROKER6 }}
- EVENTSTREAMS_USER: ${{ secrets.EVENTSTREAMS_USER }}
- EVENTSTREAMS_PASSWORD: ${{ secrets.EVENTSTREAMS_PASSWORD }}
- run: |
- pytest
+ # 1. Initialize the build
+ # -------------------------------------------------------------------------------------------
+ - name: Checkout
+ uses: actions/checkout@v4
+ # Without this option, we don't get the tag information
+ with:
+ fetch-depth: 0
+
+ - name: Initialise the build system
+ run: |
+ chmod u+x $GITHUB_WORKSPACE/build/bin/*.sh
+ $GITHUB_WORKSPACE/build/bin/initbuild.sh
+ source $GITHUB_WORKSPACE/build/bin/.functions.sh
+
+ # 2. Python Package Build
+ # -------------------------------------------------------------------------------------------
+ - name: Set up Python 3.11
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.11
+
+ - name: Build the Python package
+ run: |
+ sed -i "s#__version__ = \"100.0.0\"#__version__ = \"${{ env.VERSION_NOPREREL }}\"#g" ${GITHUB_WORKSPACE}/src/wiotp/sdk/__init__.py
+ cat ${GITHUB_WORKSPACE}/src/wiotp/sdk/__init__.py
+ python -m pip install --upgrade pip
+ pip install .[dev]
+ python -m pytest
+ env:
+ ONE_JOB_ONLY_TESTS: "true"
+ WIOTP_API_KEY: ${{ secrets.WIOTP_API_KEY }}
+ WIOTP_API_TOKEN: ${{ secrets.WIOTP_API_TOKEN }}
+ WIOTP_ORG_ID: ${{ secrets.WIOTP_ORG_ID }}
+ CLOUDANT_HOST: ${{ secrets.CLOUDANT_HOST }}
+ CLOUDANT_PORT: ${{ secrets.CLOUDANT_PORT }}
+ CLOUDANT_USERNAME: ${{ secrets.CLOUDANT_USERNAME }}
+ CLOUDANT_PASSWORD: ${{ secrets.CLOUDANT_PASSWORD }}
+ EVENTSTREAMS_API_KEY: ${{ secrets.EVENTSTREAMS_API_KEY }}
+ EVENTSTREAMS_ADMIN_URL: ${{ secrets.EVENTSTREAMS_ADMIN_URL }}
+ EVENTSTREAMS_BROKER1: ${{ secrets.EVENTSTREAMS_BROKER1 }}
+ EVENTSTREAMS_BROKER2: ${{ secrets.EVENTSTREAMS_BROKER2 }}
+ EVENTSTREAMS_BROKER3: ${{ secrets.EVENTSTREAMS_BROKER3 }}
+ EVENTSTREAMS_BROKER4: ${{ secrets.EVENTSTREAMS_BROKER4 }}
+ EVENTSTREAMS_BROKER5: ${{ secrets.EVENTSTREAMS_BROKER5 }}
+ EVENTSTREAMS_BROKER6: ${{ secrets.EVENTSTREAMS_BROKER6 }}
+ EVENTSTREAMS_USER: ${{ secrets.EVENTSTREAMS_USER }}
+ EVENTSTREAMS_PASSWORD: ${{ secrets.EVENTSTREAMS_PASSWORD }}
+
+ - name: Lint with flake8
+ run: |
+ # stop the build if there are Python syntax errors or undefined names
+ flake8 src --count --select=E9,F63,F7,F82 --show-source --statistics
+ # exit-zero treats all errors as warnings.
+ flake8 src --count --exit-zero --max-complexity=10 --max-line-length=200 --statistics

.github/workflows/python-release.yml

@@ -0,0 +1,75 @@
+name: Build Python Package
+on:
+ release:
+ types: [ published ]
+jobs:
+ release-package:
+ runs-on: ubuntu-latest
+ steps:
+ # 1. Initialize the build
+ # -------------------------------------------------------------------------------------------
+ - name: Checkout
+ uses: actions/checkout@v4
+ # Without this option, we don't get the tag information
+ with:
+ fetch-depth: 0
+
+ - name: Initialise the build system
+ run: |
+ chmod u+x $GITHUB_WORKSPACE/build/bin/*.sh
+ $GITHUB_WORKSPACE/build/bin/initbuild.sh
+ source $GITHUB_WORKSPACE/build/bin/.functions.sh
+
+ # 2. Python Package Build
+ # -------------------------------------------------------------------------------------------
+ - name: Set up Python 3.11
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.11
+
+ - name: Build the Python package
+ run: |
+ sed -i "s#__version__ = \"100.0.0\"#__version__ = \"${{ env.VERSION_NOPREREL }}\"#g" ${GITHUB_WORKSPACE}/src/wiotp/sdk/__init__.py
+ cat ${GITHUB_WORKSPACE}/src/wiotp/sdk/__init__.py
+ python -m pip install --upgrade pip
+ pip install .[dev]
+ python -m pytest
+ env:
+ ONE_JOB_ONLY_TESTS: "true"
+ WIOTP_API_KEY: ${{ secrets.WIOTP_API_KEY }}
+ WIOTP_API_TOKEN: ${{ secrets.WIOTP_API_TOKEN }}
+ WIOTP_ORG_ID: ${{ secrets.WIOTP_ORG_ID }}
+ CLOUDANT_HOST: ${{ secrets.CLOUDANT_HOST }}
+ CLOUDANT_PORT: ${{ secrets.CLOUDANT_PORT }}
+ CLOUDANT_USERNAME: ${{ secrets.CLOUDANT_USERNAME }}
+ CLOUDANT_PASSWORD: ${{ secrets.CLOUDANT_PASSWORD }}
+ EVENTSTREAMS_API_KEY: ${{ secrets.EVENTSTREAMS_API_KEY }}
+ EVENTSTREAMS_ADMIN_URL: ${{ secrets.EVENTSTREAMS_ADMIN_URL }}
+ EVENTSTREAMS_BROKER1: ${{ secrets.EVENTSTREAMS_BROKER1 }}
+ EVENTSTREAMS_BROKER2: ${{ secrets.EVENTSTREAMS_BROKER2 }}
+ EVENTSTREAMS_BROKER3: ${{ secrets.EVENTSTREAMS_BROKER3 }}
+ EVENTSTREAMS_BROKER4: ${{ secrets.EVENTSTREAMS_BROKER4 }}
+ EVENTSTREAMS_BROKER5: ${{ secrets.EVENTSTREAMS_BROKER5 }}
+ EVENTSTREAMS_BROKER6: ${{ secrets.EVENTSTREAMS_BROKER6 }}
+ EVENTSTREAMS_USER: ${{ secrets.EVENTSTREAMS_USER }}
+ EVENTSTREAMS_PASSWORD: ${{ secrets.EVENTSTREAMS_PASSWORD }}
+
+ # 3. Flake8 Linting
+ # -------------------------------------------------------------------------------------------
+ - name: Lint with flake8
+ run: |
+ # stop the build if there are Python syntax errors or undefined names
+ flake8 src --count --select=E9,F63,F7,F82 --show-source --statistics
+ # exit-zero treats all errors as warnings.
+ flake8 src --count --exit-zero --max-complexity=10 --max-line-length=200 --statistics
+
+ # 4. Publish to PyPi
+ # -------------------------------------------------------------------------------------------
+ - name: Build package
+ run: python -m build
+
+ - name: Publish package
+ uses: pypa/gh-action-pypi-publish@release/v1
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}

setup.py

@@ -25,9 +25,24 @@
 with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
  long_description = f.read()
 
+# Maintain a single source of versioning
+# https://packaging.python.org/en/latest/guides/single-sourcing-package-version/
+def read(rel_path):
+ here = os.path.abspath(os.path.dirname(__file__))
+ with codecs.open(os.path.join(here, rel_path), 'r') as fp:
+ return fp.read()
+
+def get_version(rel_path):
+ for line in read(rel_path).splitlines():
+ if line.startswith('__version__'):
+ delim = '"' if '"' in line else "'"
+ return line.split(delim)[1]
+ else:
+ raise RuntimeError("Unable to find version string.")
+
 setup(
  name='wiotp-sdk',
- version="1.0.0",
+ version=get_version("src/wiotp/sdk/__init__.py"),
  author='David Parker',
  author_email='[email protected]',
  package_dir={'': 'src'},

src/wiotp/sdk/__init__.py

@@ -8,7 +8,7 @@
 #
 # *****************************************************************************
 
-__version__ = "0.11.0"
+__version__ = "100.0.0"
 
 # Expose the public API for the entire SDK
 #