Changelog

All notable changes to the parent-lookup project will be documented in this file.
The changelog format is based on Keep a Changelog.

Unreleased

  • -/-

0.2.3 - 2026-04-11

Added

  • Added a new generic descriptor API, ParentLookup, as an optional alternative to implementing child-side find_parent methods.

  • Added project-specific instruction files for agentic coding:

    • .instructions.md and .prompt.md in root folder (these two instruction files are tool agnostic and generally expected to be consumed by agents)

    • plans/.plan.md as a template file for specific plan.md file(s)

    • .github/copilot-instructions.md as a GitHub Copilot specific amendment / refinement to .instructions.md and .prompt.md

0.2.2 - 2026-04-10

Changed

  • GitHub Workflows:

    • Added ‘name: Checkout code’ to uses of ‘actions/checkout’, for better readability and consistency across workflow files.

    • Added ‘name: Download build artifacts’ to uses of ‘actions/download-artifact’, for better readability and consistency across workflow files.

    • Added ‘name: Publish to PyPI’ to uses of ‘pypa/gh-action-pypi-publish’, for better readability and consistency across workflow files.

    • Added ‘name: Upload build artifacts’ to uses of ‘actions/upload-artifact’, for better readability and consistency across workflow files.

    • Changed ‘uv sync –upgrade’ to ‘uv sync -U’

    • Ensured that actions ‘upload-artifact’ and ‘download-artifact’ uniformly specify ‘dist’ as (file)name for the artifact uploaded (or downloaded, respectively), for consistency across workflow files.

    • pull_request_to_main.yml and nightly_build.yml: Added ‘workflow_dispatch:’ in selected workflows to allow manual trigger of the workflow.

    • Removed redundant ‘Set up Python’ steps (no longer needed, as ‘uv sync’ will automatically install Python if not present).

    • Replaced ‘Build source distribution and wheel’ with ‘Build source distribution and wheels’ (plural) in workflow step names.

    • Replaced ‘Run twine check’ with ‘Check build artifacts’ in workflow step names, to better reflect the purpose of the step.

    • Updated the syntax used for the OS and Python matrix in test workflows.

  • pyproject.toml:

    • Removed upper version constraint from required Python version, i.e. changed the “requires-python” field from “>= 3.11, < 3.15” to “>= 3.11”.
      Detailed background and reasoning in this good yet long post by Henry Schreiner: https://iscinumpy.dev/post/bound-version-constraints/#pinning-the-python-version-is-special
      TLDR: Placing an upper Python version constraint on a Python package causes more harm than it provides benefits. The upper version constraint unnecessarily manifests incompatibility with future Python releases. Removing the upper version constraint ensures the package remains installable as Python evolves. In the majority of cases, the newer Python version will anyhow be backward-compatible. And in the rare case where your package would really not work with a newer Python version, users can at least find a solution manually to resolve the conflict, e.g. by pinning your package to the last version compatible with the environment they install it in. That way, we ensure it remains possible for users to find a solution, instead of rendering it impossible forever.

  • Sphinx Documentation:

    • Sphinx conf.py: Updated year in copyright statement to 2026

  • VS Code Settings (Recommended extensions):

    • Removed ‘njqdev.vscode-python-typehint’ (Python Type Hint). Not maintained for a year, and the functionality is now covered by GitHub Copilot.

    • Added ‘ms-python.debugpy’ (Python Debugger).

    • Added ‘ms-python.vscode-python-envs’ (Python Environments).

  • README.md:

    • Updated year in copyright statement to 2026

    • Removed the ‘Install Python’ step (### 2. Install Python), as Python gets automatically installed when running uv sync and installing Python separately (non uv-managed Python) is no longer common. Current best practice is to install Python through uv (uv-managed Python).

  • tests/lookup/*.py: Removed __init__.py file and changed import statements to local imports

  • Updated code base with latest changes in python_project_template v0.2.11

Dependencies

  • .pre-commit-config.yaml: Updated rev of ruff-pre-commit to v0.15.9

  • Updated to furo>=2025.12

  • Updated to jupyter>=1.1.1

  • Updated to mypy>=1.19.1

  • Updated to myst-parser>=5.0

  • Updated to pre-commit>=4.5

  • Updated to pyright>=1.1.408

  • Updated to pytest-cov>=7.1

  • Updated to pytest>=9.0

  • Updated to ruff>=0.15.9

  • Updated to sourcery>=1.43.0

  • Updated to sphinx-argparse-cli>=1.21.3

  • Updated to sphinx-autodoc-typehints>=3.6

  • Updated to Sphinx>=9.0

  • Updated to sphinxcontrib-mermaid>=2.0

0.2.1 - 2025-11-23

Added

  • Added support for Python 3.14

Removed

  • Removed support for Python 3.10

Dependencies

  • Updated to ruff>=0.14.3 (from ruff>=0.9.2)

  • Updated to pyright>=1.1.407 (from pyright>=1.1.392)

  • Updated to sourcery>=1.40 (from sourcery>=1.31)

  • Updated to pytest>=8.4 (from pytest>=8.3)

  • Updated to pytest-cov>=7.0 (from pytest-cov>=6.0)

  • Updated to Sphinx>=8.2 (from Sphinx>=8.1)

  • Updated to sphinx-argparse-cli>=1.20 (from sphinx-argparse-cli>=1.19)

  • Updated to sphinx-autodoc-typehints>=3.5 (from sphinx-autodoc-typehints>=3.0)

  • Updated to furo>=2025.9 (from furo>=2024.8)

  • Updated to pre-commit>=4.3 (from pre-commit>=4.0)

  • Updated to mypy>=1.18 (from mypy>=1.14)

  • Updated to checkout@v5 (from checkout@v4)

  • Updated to setup-python@v6 (from setup-python@v5)

  • Updated to setup-uv@v7 (from setup-uv@v5)

  • Updated to upload-artifact@v5 (from upload-artifact@v4)

  • Updated to download-artifact@v5 (from download-artifact@v4)

Changed

  • Do not run code quality checks in nightly builds

  • Included uv.lock file in version control

  • pyproject.toml:

    • added required-environments to uv.tools (windows, linux, macos)

    • updated required Python version to “>= 3.11, < 3.15”

    • updated supported Python versions to 3.11, 3.12, 3.13, 3.14

    • removed deprecated pyright setting ‘reportShadowedImports’

    • removed leading carets and trailing slashes from ‘exclude’ paths

    • removed trailing slashes from ‘exclude’ paths

  • ruff.toml:

    • updated target Python version to “py311”

    • Added file-specific ignores for docs/source/conf.py

  • .sourcery.yaml:

    • updated the lowest Python version the project supports to ‘3.11’

  • GitHub workflow _test.yml:

    • updated Python versions in test matrix to 3.11, 3.12, 3.13, 3.14

  • GitHub workflow _test_future.yml:

    • updated Python version in test_future to 3.15.0-alpha - 3.15.0

  • .pre-commit-config.yaml:

    • updated rev of pre-commit-hooks to v6.0.0

    • updated rev of ruff-pre-commit to v0.14.3

    • updated id of ruff to ruff-check

  • Sphinx conf.py:

    • removed ruff rule exception on file level

  • VS Code settings:

    • (Recommended extensions) Removed deprecated IntelliCode extension and replaced it by GitHub Copilot Chat as recommended replacement.

    • Updated ‘mypy-type-checker.reportingScope’ to ‘custom’.

0.2.0 - 2025-02-03

  • Initial release

0.1.1 - 2025-02-03

  • Beta release

0.0.1 - 2025-02-03

  • Beta release

Added

  • added this

Changed

  • changed that

Dependencies

  • updated to some_package_on_pypi>=0.1.0

Fixed

  • fixed issue #12345

Deprecated

  • following features will soon be removed and have been marked as deprecated:

    • function x in module z

Removed

  • following features have been removed:

    • function y in module z