Feature/sbachmei/improve python version handling (#5)

* update readme with pip install instructions

* auto-extract python versions for test matrix

* Auto-update README when supported python versions change

* import ConfigNode and custom errors at package level

* bugfix add value_name attr to ConfigurationError

---------

Co-authored-by: github-actions <action@github.com>

Author: stevebachmeier

.github/workflows/build.yml

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 #   - invoked on push, pull_request, manual trigger, or schedule
-#   - test under at least 3 versions of python
+#   - test under all supported versions of python (see python_versions.json)
 # -----------------------------------------------------------------------------
 name: build
 on:
@@ -11,11 +11,25 @@ on:
     - cron: "0 8 * * *"
 
 jobs:
+  get-python-versions:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install jq
+        run: sudo apt-get install jq
+      - name: Get Python versions
+        id: set-matrix
+        run: |
+          echo "MATRIX_RESULT=$(jq -c . python_versions.json)" >> $GITHUB_ENV
+    outputs:
+      matrix: ${{ env.MATRIX_RESULT }}
   build:
+    needs: get-python-versions
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ${{ fromJSON(needs.get-python-versions.outputs.matrix) }}
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}

.github/workflows/update_readme.yml

@@ -0,0 +1,33 @@
+# -----------------------------------------------------------------------------
+#   - invoked on push to any branch
+# -----------------------------------------------------------------------------
+name: update README
+
+on: push
+
+jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - name: Update README
+        run: |
+          pip install packaging
+          python update_readme.py
+      - name: Commit and push changes
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "github-actions"
+          git diff --quiet && git diff --staged --quiet || (
+            git add README.rst
+            git commit -am "update README with supported Python versions"
+            git pull --rebase origin ${{ github.ref_name }}
+            git push origin ${{ github.ref_name }}
+          )
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.rst

@@ -1,3 +1,9 @@
+**1.0.1 - 04/11/2024**
+
+ - Extract python version test matrix from python_versions.json
+ - Automatically update README when supported python versions change
+ - Bugfix missing ConfigurationError attribute
+
 **1.0.0 - 04/11/2024**
 
  - Initial release

README.rst

@@ -4,9 +4,13 @@ Layered Config Tree
 
 Layered Config Tree is a configuration structure that supports cascading layers.
 
-**Layered Config Tree requires Python 3.8-3.11 to run**
+**Supported Python versions: 3.8, 3.9, 3.10, 3.11**
 
-You can build ``layered_config_tree`` from from source with
+You can install ``layered_config_tree`` from PyPI with pip:
+
+  ``> pip install layered_config_tree``
+
+or build it from from source:
 
   ``> git clone https://github.com/ihmeuw/layered_config_tree.git``
 

pyproject.toml

@@ -1,3 +1,6 @@
+[build-system]
+requires = ["packaging", "setuptools"]
+
 [tool.black]
 line_length = 94
 

python_versions.json

@@ -0,0 +1 @@
+["3.8", "3.9", "3.10", "3.11"]

setup.py

@@ -1,18 +1,28 @@
+import json
 import sys
 from pathlib import Path
 
+from packaging.version import parse
 from setuptools import find_packages, setup
 
-min_version, max_version = ((3, 8), "3.8"), ((3, 11), "3.11")
+with open("python_versions.json", "r") as f:
+    supported_python_versions = json.load(f)
 
-if not (min_version[0] <= sys.version_info[:2] <= max_version[0]):
-    # Python 3.5 does not support f-strings
+python_versions = [parse(v) for v in supported_python_versions]
+min_version = min(python_versions)
+max_version = max(python_versions)
+if not (
+    min_version <= parse(".".join([str(v) for v in sys.version_info[:2]])) <= max_version
+):
     py_version = ".".join([str(v) for v in sys.version_info[:3]])
+    # NOTE: Python 3.5 does not support f-strings
     error = (
         "\n----------------------------------------\n"
         "Error: Layered Config Tree runs under python {min_version}-{max_version}.\n"
         "You are running python {py_version}".format(
-            min_version=min_version[1], max_version=max_version[1], py_version=py_version
+            min_version=min_version.base_version,
+            max_version=max_version.base_version,
+            py_version=py_version,
         )
     )
     print(error, file=sys.stderr)

src/layered_config_tree/__init__.py

@@ -8,4 +8,9 @@
     __uri__,
 )
 from layered_config_tree._version import __version__
-from layered_config_tree.main import LayeredConfigTree
+from layered_config_tree.exceptions import (
+    ConfigurationError,
+    ConfigurationKeyError,
+    DuplicatedConfigurationError,
+)
+from layered_config_tree.main import ConfigNode, LayeredConfigTree

src/layered_config_tree/exceptions.py

@@ -6,6 +6,7 @@ class ConfigurationError(Exception):
 
     def __init__(self, message: str, value_name: Optional[str]):
         super().__init__(message)
+        self.value_name = value_name
 
 
 class ConfigurationKeyError(ConfigurationError, KeyError):

src/layered_config_tree/main.py

@@ -32,7 +32,7 @@
 
 import yaml
 
-from layered_config_tree.exceptions import (
+from layered_config_tree import (
     ConfigurationError,
     ConfigurationKeyError,
     DuplicatedConfigurationError,