Merge pull request #8 from Nieuwe-Warmte-Nu/release-0.0.5

Release 0.0.5 & 0.0.6

Author: MarkTNO

.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: PyPi release
+run-name: Releasing next version 🚀
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+
+      - name: deps
+        run: python -m pip install -U build
+
+      - name: build
+        run: python -m build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -2,17 +2,7 @@
 Nieuwe Warmte Nu
 
 
-## install/update pip package
-see
-https://packaging.python.org/en/latest/tutorials/packaging-projects/#:~:text=Generating%20distribution%20archives  
-Update version in `pyproject.toml`.  
-In root directory:
-```
-py -m build
-twine upload dist/*
-```
-
-## usage
+## Usage
 Install in development mode, in root directory:
 ```
 pip install -e .
@@ -87,4 +77,17 @@ try:
 finally:
     nwn_client.stop()
 
-```
+```
+
+## Release
+This package is released on pypi [here](https://pypi.org/project/nwnsdk/) whenever a new tag is pushed.
+In order to release this package:
+
+1. Make sure that all relevant merge requests and commits have been merged to the master and/or poc-release branch.
+2. Run `git checkout master` or `git checkout poc-release` to switch to the release branch.
+3. Run `git pull origin master` or `git pull origin poc-release` to pull all latest changes.
+4. Run `git tag <new_version>` where `<new_version>` is the new version number.
+5. Run `git push origin <new_version>` to push the tag to Github.
+6. Check [Github](https://github.com/Nieuwe-Warmte-Nu/compute-engine-sdk-python/actions) to confirm the release is
+   processed without errors.
+7. Once the release has finished, confirm the new version is available on [pypi](https://pypi.org/project/nwnsdk/).

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nwnsdk"
-version = "0.0.4"
+dynamic = ["version"]
 authors = [{ name = "NieuweWarmteNu", email = "[email protected]" }]
 description = "Nieuwe Warmte Nu - compute engine sdk python"
 classifiers = [
@@ -17,7 +17,7 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Physics",
 ]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.8"
 
 dependencies = [
     "python-dotenv==1.0.0",
@@ -31,3 +31,10 @@ dependencies = [
 [project.urls]
 "Homepage" = "https://github.com/pypa/sampleproject"
 "Bug Tracker" = "https://github.com/pypa/sampleproject/issues"
+
+[build-system]
+requires = ["setuptools", "setuptools-git-versioning<2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools-git-versioning]
+enabled = true