Introduce ChainableArray class and add mapping functions

.github/workflows/ci.yml

@@ -32,24 +32,20 @@ jobs:
     outputs:
       wheel-distribution: ${{ steps.wheel-distribution.outputs.path }}
     steps:
-      - uses: actions/checkout@v3
-        with: {fetch-depth: 0}  # deep clone for setuptools-scm
-      - uses: actions/setup-python@v4
-        id: setup-python
-        with: {python-version: "3.11"}
+      - uses: actions/checkout@v5
+        with: {fetch-depth: 0}  # deep clone for hatch-scm
+      - uses: astral-sh/setup-uv@v8.1.0
       - name: Run static analysis and format checkers
-        run: pipx run pre-commit run --all-files --show-diff-on-failure
+        run: uv run pre-commit run --all-files --show-diff-on-failure
       - name: Build package distribution files
-        run: >-
-          pipx run --python '${{ steps.setup-python.outputs.python-path }}'
-          tox -e clean,build
+        run: uv run tox -e clean,build
       - name: Record the path of wheel distribution
         id: wheel-distribution
         run: echo "path=$(ls dist/*.whl)" >> $GITHUB_OUTPUT
       - name: Store the distribution files for use in other stages
         # `tests` and `publish` will use the same pre-built distributions,
         # so we make sure to release the exact same package that was tested
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: python-distribution-files
           path: dist/
@@ -60,29 +56,28 @@ jobs:
     strategy:
       matrix:
         python:
-        - "3.7"  # oldest Python supported by PSF
-        - "3.11"  # newest Python that is stable
+        - "3.10"  
+        - "3.11"  # oldest Python supported by PSF
+        - "3.12"  # oldest Python supported by PSF
+        - "3.13"  # oldest Python supported by PSF
+        - "3.14"  # newest Python that is stable
         platform:
         - ubuntu-latest
         - macos-latest
         - windows-latest
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        id: setup-python
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v8.1.0
         with:
           python-version: ${{ matrix.python }}
       - name: Retrieve pre-built distribution files
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with: {name: python-distribution-files, path: dist/}
       - name: Run tests
         run: >-
-          pipx run --python '${{ steps.setup-python.outputs.python-path }}'
-          tox --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
+          uv run tox --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
           -- -rFEx --durations 10 --color yes  # pytest args
-      - name: Generate coverage report
-        run: pipx run coverage lcov -o coverage.lcov
       - name: Upload partial coverage report
         uses: coverallsapp/github-action@master
         with:
@@ -100,26 +95,29 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel-finished: true
+      - name: debug
+        run: echo "ref=${{ github.ref }} event=${{ github.event_name }}"
+
+
 
   publish:
     needs: finalize
-    if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags/') }}
+    if: ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && contains(github.ref, 'refs/tags/') }}
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with: {python-version: "3.11"}
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v8.1.0
       - name: Retrieve pre-built distribution files
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with: {name: python-distribution-files, path: dist/}
       - name: Publish Package
         env:
           # TODO: Set your PYPI_TOKEN as a secret using GitHub UI
           # - https://pypi.org/help/#apitoken
           # - https://docs.github.com/en/actions/security-guides/encrypted-secrets
-          TWINE_REPOSITORY: pypi
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-        run: pipx run tox -e publish
+          UV_PUBLISH_URL: https://upload.pypi.org/legacy/
+          UV_PUBLISH_USERNAME: __token__
+          UV_PUBLISH_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: uv run tox -e publish

.gitignore

@@ -52,3 +52,6 @@ MANIFEST
 .venv*/
 .conda*/
 .python-version
+
+# .env file for Environment Variables
+.env

.pre-commit-config.yaml

@@ -1,67 +1,37 @@
-exclude: '^docs/conf.py'
+exclude: '^docs/conf.py|^uv\.lock$'
 
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.4.0
   hooks:
-  - id: trailing-whitespace
   - id: check-added-large-files
+    exclude: uv.lock
   - id: check-ast
   - id: check-json
   - id: check-merge-conflict
   - id: check-xml
   - id: check-yaml
-  - id: debug-statements
   - id: end-of-file-fixer
-  - id: requirements-txt-fixer
+    exclude: "uv.lock"
   - id: mixed-line-ending
+    exclude: "uv.lock"
     args: ['--fix=auto']  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
 
-## If you want to automatically "modernize" your Python code:
-# - repo: https://github.com/asottile/pyupgrade
-#   rev: v3.7.0
-#   hooks:
-#   - id: pyupgrade
-#     args: ['--py37-plus']
-
-## If you want to avoid flake8 errors due to unused vars or imports:
-# - repo: https://github.com/PyCQA/autoflake
-#   rev: v2.1.1
-#   hooks:
-#   - id: autoflake
-#     args: [
-#       --in-place,
-#       --remove-all-unused-imports,
-#       --remove-unused-variables,
-#     ]
-
-- repo: https://github.com/PyCQA/isort
-  rev: 5.12.0
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.0  # check latest
   hooks:
-  - id: isort
+    - id: ruff          # replaces isort + flake8
+      args: [--fix]     # auto-fix where possible
+    - id: ruff-format   # replaces black
 
-- repo: https://github.com/psf/black
-  rev: 23.7.0
+- repo: https://github.com/kynan/nbstripout
+  rev: 0.8.1
   hooks:
-  - id: black
-    language_version: python3
+    - id: nbstripout
+      args: [--extra-keys=metadata.kernelspec metadata.language_info]
 
-## If like to embrace black styles even in the docs:
-# - repo: https://github.com/asottile/blacken-docs
-#   rev: v1.13.0
-#   hooks:
-#   - id: blacken-docs
-#     additional_dependencies: [black]
 
-- repo: https://github.com/PyCQA/flake8
-  rev: 6.0.0
+- repo: https://github.com/astral-sh/uv-pre-commit
+  rev: 0.6.0  # check latest
   hooks:
-  - id: flake8
-  ## You can add flake8 plugins via `additional_dependencies`:
-  #  additional_dependencies: [flake8-bugbear]
-
-## Check for misspells in documentation files:
-# - repo: https://github.com/codespell-project/codespell
-#   rev: v2.2.5
-#   hooks:
-#   - id: codespell
+    - id: uv-lock  # updates uv.lock when pyproject.toml changes

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Dennis Reinsch
+Copyright (c) 2023-2025 Thomas Hermann and Dennis Reinsch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -45,23 +45,65 @@ pyamapping
 Making Changes & Contributing
 =============================
 
-This project uses `pre-commit`_, please make sure to install it before making any
-changes::
+To setup your development environment, you need to have `uv <https://docs.astral.sh/uv/>`_ installed.
+First, clone the repository and then change into the root directory:
+
+.. code-block:: bash
 
-    pip install pre-commit
     cd pyamapping
-    pre-commit install
 
-It is a good idea to update the hooks to the latest version::
+Afterwards, sync your environment:
+
+.. code-block:: bash
+
+    uv sync
+
+This will install all required dependencies (dev dependencies included).
+Also, please install the pre-commit hooks:
+
+.. code-block:: bash
+
+    uv run pre-commit install
+
+Experimentation in Scratchpad / Jupyter
+----------------------------------------
+
+uv automatically installs the ``pyamapping`` package to the ``.venv`` in editable mode.
+During development, any changes to the ``pyamapping`` source will be reflected automatically.
+To write playground / exploratory code, just make sure to run your REPL environment with ``uv run``, e.g.:
+
+.. code-block:: bash
+
+    uv run python
+
+or
+
+.. code-block:: bash
+
+    uv run jupyter notebook
+
+Then, you should be able to:
+
+.. code-block:: python
+
+    import pyamapping as pam
+
+And get the current state of the source code.
+
+Running Tests
+-------------
+
+Tests can be run via:
+
+.. code-block:: bash
 
-    pre-commit autoupdate
+    uv run tox -e tests
 
-Don't forget to tell your contributors to also install and use pre-commit.
+Building Documentation
+----------------------
 
-.. _pre-commit: https://pre-commit.com/
+Documentation can be built via:
 
-Note
-====
+.. code-block:: bash
 
-This project has been set up using PyScaffold 4.5. For details and usage
-information on PyScaffold see https://pyscaffold.org/.
+    uv run tox -e docs