pymetadata 0.4.2__tar.gz → 0.5.0__tar.gz

pymetadata-0.5.0/.bumpversion.toml

@@ -0,0 +1,19 @@
+[tool.bumpversion]
+current_version = "0.5.0"
+commit = true
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+tag = true
+sign_tags = false
+tag_name = "{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+message = "Bump version: {current_version} → {new_version}"
+commit_args = ""
+
+[[tool.bumpversion.files]]
+filename = "./src/pymetadata/__init__.py"

pymetadata-0.5.0/.github/CONTRIBUTING.rst

@@ -0,0 +1,141 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Report Bugs
+===========
+
+Report bugs at https://github.com/matthiaskoenig/pymetadata/issues.
+
+If you are reporting a bug, please follow the template guide lines. The more
+detailed your report, the easier and thus faster we can help you.
+
+Fix Bugs
+========
+
+Look through the GitHub issues for bugs.
+
+Implement Features
+==================
+
+Look through the GitHub issues for features.
+
+Write Documentation
+===================
+
+pymetadata could always use more documentation, whether as part of the official
+documentation, in docstrings, or even on the web in blog posts, articles, and
+such.
+
+Submit Feedback
+===============
+
+The best way to send feedback is to file an issue at
+https://github.com/matthiaskoenig/pymetadata/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions are
+  welcome :)
+
+Get Started!
+============
+
+Ready to contribute? Here's how to set up pymetadata for local development.
+
+1. Fork the https://github.com/matthiaskoenig/pymetadata repository on GitHub. If you
+   have never done this before, `follow the official guide
+   <https://guides.github.com/activities/forking/>`_
+2. Clone your fork locally as described in the same guide.
+3. Install your local copy into a a Python virtual environment. We recommend using ``uv`` for
+   managing the environments
+
+   .. code-block:: console
+
+        # install dependencies
+        uv sync
+        # install dev dependencies
+        uv pip install -r pyproject.toml --extra dev
+        # install tox-uv support
+        uv tool install tox --with tox-uv
+
+
+4. Create a branch for local development using the ``develop`` branch as a
+   starting point.
+
+   .. code-block:: console
+
+       git checkout devel
+       git checkout -b fix-name-of-your-bugfix
+
+   Now you can make your changes locally.
+
+5. When making changes locally, it is helpful to ``git commit`` your work
+   regularly. On one hand to save your work and on the other hand, the smaller
+   the steps, the easier it is to review your work later.
+
+   .. code-block:: console
+
+       git add .
+       git commit -m "fix: Your summary of changes"
+
+6. When you're done making changes, check that your changes pass our test suite.
+   This is all included with tox
+
+   .. code-block:: console
+
+       tox run-parallel
+
+
+7. Push your branch to GitHub.
+
+   .. code-block:: console
+
+       git push origin fix-name-of-your-bugfix
+
+8. Open the link displayed in the message when pushing your new branch in order
+   to submit a pull request. Please follow the template presented to you in the
+   web interface to complete your pull request.
+
+For larger features that you want to work on collaboratively with other pymetadata
+team members, you may consider to first request to join the pymetadata developers
+team to get write access to the repository so that you can create a branch in
+the main repository (or simply ask the maintainer to create a branch for you).
+Once you have a new branch you can push your changes directly to the main
+repository and when finished, submit a pull request from that branch to
+``develop``.
+
+Unit tests and benchmarks
+-------------------------
+
+pymetadata uses `pytest <http://docs.pytest.org/en/latest/>`_ for its
+unit-tests and new features should in general always come with new
+tests that make sure that the code runs as intended. 
+
+To run all tests do::
+
+    $ tox run-parallel
+
+Branching model
+---------------
+
+``develop``
+    Is the branch all pull-requests should be based on.
+``main``
+    Is only touched by maintainers and is the branch with only tested, reviewed
+    code that is released or ready for the next release.
+``{fix, bugfix, doc, feature}/descriptive-name``
+    Is the recommended naming scheme for smaller improvements, bugfixes,
+    documentation improvement and new features respectively.
+
+Please use concise descriptive commit messages and consider using
+``git pull --rebase`` when you update your own fork to avoid merge commits.
+
+Thank you very much for contributing to pymetadata!

pymetadata-0.5.0/.github/ISSUE_TEMPLATE/01-bug-report.md

@@ -0,0 +1,49 @@
+---
+name: Bug report
+about: Report a bug to help improve this project
+---
+
+<!--
+
+Before you create a new problem report, please look through the list of existing open
+ and closed issues to see if there are similar ones.
+ 
+https://github.com/matthiaskoenig/pymetadata/issues
+
+-->
+
+#### Problem description
+
+Please explain:
+* **what** you tried to achieve,
+* **how** you went about it (referring to the code sample), and
+* **why** the current behaviour is a problem and what output
+  you expected instead.
+
+#### Code Sample
+
+Create a [minimal, complete, verifiable example](https://stackoverflow.com/help/mcve).
+
+<!-- Paste your code between the ``` tickmarks below or link to a gist. -->
+```python
+```
+
+<!-- If there was a crash, please include the traceback between the ``` tickmarks below. -->
+```
+```
+
+### Context
+
+<!-- Run the following code and paste the output between the ``` tickmarks below
+inside the details block.
+
+python -c "import pymetadata;pymetadata.show_versions()"
+
+-->
+
+<details>
+
+```
+```
+
+</details>

pymetadata-0.5.0/.github/ISSUE_TEMPLATE/02-question.md

@@ -0,0 +1,15 @@
+---
+name: Question
+about: Ask a question
+---
+
+### Checklist
+
+<!-- To help keep this issue tracker clean and focused, please make sure that you have
+ tried *all* of the following resources before submitting your question. -->
+
+- [ ] I looked through [similar issues on GitHub](https://github.com/matthiaskoenig/pymetadata/issues).
+
+### Question
+
+<!-- Please ask your question here. -->

pymetadata-0.5.0/.github/ISSUE_TEMPLATE/03-feature-request.md

@@ -0,0 +1,36 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+### Checklist
+
+<!-- Please make sure you check all these items before submitting your feature request. -->
+
+- [ ] There are [no similar issues or pull requests](https://github.com/matthiaskoenig/pymetadata/issues) for this yet.
+
+### Is your feature related to a problem? Please describe it.
+
+<!--
+A clear and concise description of what you are trying to achieve.
+"I want to be able to [...] but I can't because [...]".
+-->
+
+## Describe the solution you would like.
+
+<!--
+A clear and concise description of what you would want to happen.
+For API changes, try to provide a code snippet of what you would like the new API to
+look like.
+-->
+
+## Describe alternatives you considered
+
+<!--
+Please describe any alternative solutions or features you've considered to solve
+your problem and why they wouldn't solve it.
+-->
+
+## Additional context
+
+<!-- Provide any additional context, screenshots, tracebacks, etc. about the feature here. -->

pymetadata-0.5.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: true

pymetadata-0.5.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+* [ ] fix #(issue number)
+* [ ] description of feature/fix
+* [ ] tests added/passed
+* [ ] add an entry to the [next release](../release-notes/next-release.md)

pymetadata-0.5.0/.github/SUPPORT.rst

@@ -0,0 +1,6 @@
+=======
+Support
+=======
+
+* You can post questions in `GitHub issues
+  <https://github.com/matthiaskoenig/pymetadata/issues>`_.

pymetadata-0.5.0/.github/workflows/main.yml

@@ -0,0 +1,71 @@
+name: CI-CD
+
+on: [push]
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip wheel
+        python -m pip install tox tox-gh-actions
+
+    # Update output format to enable automatic inline annotations.
+    - name: Test with tox
+      run:
+        tox --
+
+  release:
+    needs: test
+    if: startsWith(github.ref, 'refs/tags')
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.13"]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/<your-pypi-project-name>
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Get tag
+      id: tag
+      run: echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install hatch twine
+
+    - name: Build package
+      # run: python setup.py sdist bdist_wheel
+      run: hatch build
+    - name: Check the package
+      run: twine check dist/*
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        packages-dir: dist
+    - name: Create GitHub release
+      uses: softprops/action-gh-release@v1
+      with:
+        body_path: "release-notes/${{ github.ref_name }}.md"
+        draft: false
+        prerelease: false

pymetadata-0.5.0/.github/workflows/ruff.yml

@@ -0,0 +1,8 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3

pymetadata-0.5.0/.gitignore

@@ -0,0 +1,28 @@
+.vscode
+*.pyc
+*~
+.DS_Store
+.eggs/
+dist
+build
+.idea
+cover/
+.tox/
+.venv
+.cache/
+.coverage
+coverage.xml
+.benchmark
+src/pymetadata.egg-info/
+src/pymetadata/resources/cache
+
+
+wheels
+__pycache__
+.pytest_cache
+.Rhistory
+*.tsv#
+*.xlsx#
+
+# OWL ontologies
+*.owl.gz

pymetadata-0.5.0/.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.8.6
+  hooks:
+    # Run the linter.
+    - id: ruff
+      types_or: [ python, pyi ]
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+      types_or: [ python, pyi ]

pymetadata-0.5.0/.python-version

@@ -0,0 +1 @@
+3.12

pymetadata-0.5.0/.ruff.toml

@@ -0,0 +1,50 @@
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+target-version = "py313"
+
+
+[lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[lint.pydocstyle]
+convention = "google"  # Accepts: "google", "numpy", or "pep257".

pymetadata-0.5.0/.zenodo.json

@@ -0,0 +1,22 @@
+{
+  "upload_type": "software",
+  "title": "pymetadata are python utilities for working with metadata",
+  "creators": [
+    {
+      "orcid": "0000-0003-1725-179X",
+      "affiliation": "Humboldt-University Berlin, Institute for Theoretical Biology, Berlin",
+      "name": "König, Matthias"
+    }
+  ],
+  "description": "<p><code>pymetadata</code> is a collection of python utilities for working with metadata in the context of COMBINE standards with source code available from available from <a href=\"https://github.com/matthiaskoenig/pymetadata\">https://github.com/matthiaskoenig/pymetadata</a></p><p>Features include among others<ul><li>annotation classes and helpers</li></ul></p><p>If you have any questions or issues please <a href=\"https://github.com/matthiaskoenig/pymetadata/issues\">open an issue</a></p><h2>Funding</h2><p>Matthias König (MK) was supported by the Federal Ministry of Education and Research (BMBF, Germany) within the research network Systems Medicine of the Liver (**LiSyM**, grant number 031L0054). MK is supported by the Federal Ministry of Education and Research (BMBF, Germany) within ATLAS by grant number 031L0304B and by the German Research Foundation (DFG) within the Research Unit Program FOR 5151 QuaLiPerF (Quantifying Liver Perfusion-Function Relationship in Complex Resection - A Systems Medicine Approach) by grant number 436883643 and by grant number 465194077 (Priority Programme SPP 2311, Subproject SimLivA).</p>",
+  "access_right": "open",
+  "license": "MIT",
+  "keywords": [
+	"modeling",
+	"standardization",
+	"COMBINE",
+	"metadata",
+	"archive",
+	"annotation"
+  ]
+}

pymetadata-0.5.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Matthias König
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{pymetadata-0.4.2/src/pymetadata.egg-info → pymetadata-0.5.0}/PKG-INFO

@@ -1,53 +1,44 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pymetadata
-Version: 0.4.2
+Version: 0.5.0
 Summary: pymetadata are python utilities for working with metadata.
-Home-page: https://github.com/matthiaskoenig/pymetadata
-Download-URL: https://pypi.org/project/pymetadata
-Author: Matthias Koenig
-Author-email: konigmatt@googlemail.com
-Maintainer: Matthias Koenig
-Maintainer-email: konigmatt@googlemail.com
-License: LGPL-3.0
-Project-URL: Source Code, https://github.com/matthiaskoenig/pymetadata
-Project-URL: Documentation, https://github.com/matthiaskoenig/pymetadata
-Project-URL: Bug Tracker, https://github.com/matthiaskoenig/pymetadata/issues
-Keywords: modeling,standardization,COMBINE,metadata,archive,annotation
+Author-email: Matthias König <konigmatt@googlemail.com>
+Maintainer-email: Matthias König <konigmatt@googlemail.com>
+License-File: LICENSE
+Keywords: COMBINE,annotation,archive,metadata,modeling,standardization
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
-Requires-Python: >=3.9
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-Requires-Dist: depinfo>=1.7
-Requires-Dist: lxml>=5.2
-Requires-Dist: rich>=13.7
-Requires-Dist: requests>=2.31
-Requires-Dist: zeep>=4.2.1
-Requires-Dist: pronto>=2.5.6
+Requires-Python: >=3.10
+Requires-Dist: depinfo>=2.2.0
 Requires-Dist: fastobo>=0.12.3
-Requires-Dist: jinja2>=3.1
-Requires-Dist: xmltodict>=0.13.0
-Requires-Dist: pydantic>=2.6
-Provides-Extra: development
-Requires-Dist: pip-tools>=7.4.1; extra == "development"
-Requires-Dist: black>=24.3.0; extra == "development"
-Requires-Dist: bump2version>=1.0.1; extra == "development"
-Requires-Dist: isort>=5.13.2; extra == "development"
-Requires-Dist: tox>=4.12.2; extra == "development"
-Requires-Dist: flake8>=7.0.0; extra == "development"
-Requires-Dist: flake8-mypy>=17.8.0; extra == "development"
-Requires-Dist: mypy>=1.9.0; extra == "development"
-Requires-Dist: pytest>=8.1.1; extra == "development"
-Requires-Dist: pytest-cov>=5.0.0; extra == "development"
+Requires-Dist: jinja2>=3.1.5
+Requires-Dist: lxml>=5.3
+Requires-Dist: pronto>=2.5.8
+Requires-Dist: pydantic>=2.10.4
+Requires-Dist: requests>=2.32.3
+Requires-Dist: rich>=13.9.4
+Requires-Dist: xmltodict>=0.14.2
+Requires-Dist: zeep>=4.3.1
+Provides-Extra: dev
+Requires-Dist: bump-my-version>=0.29.0; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: mypy>=1.9.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.0.1; extra == 'dev'
+Requires-Dist: ruff>=0.8.6; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0.0; extra == 'test'
+Requires-Dist: pytest>=8.1.1; extra == 'test'
+Requires-Dist: tox>=4.14.2; extra == 'test'
+Description-Content-Type: text/x-rst
 
 .. image:: https://github.com/matthiaskoenig/pymetadata/raw/develop/docs/images/favicon/pymetadata-100x100-300dpi.png
    :align: left
@@ -55,7 +46,7 @@ Requires-Dist: pytest-cov>=5.0.0; extra == "development"
 
 pymetadata: python utilities for metadata and COMBINE archives
 ==============================================================
-|icon1| |icon2| |icon3| |icon4| |icon5| |icon6| |icon7|
+|icon1| |icon2| |icon3| |icon4| |icon5| |icon6|
 
 
 .. |icon1| image:: https://github.com/matthiaskoenig/pymetadata/workflows/CI-CD/badge.svg
@@ -68,15 +59,12 @@ pymetadata: python utilities for metadata and COMBINE archives
    :target: https://pypi.org/project/pymetadata/
    :alt: Supported Python Versions
 .. |icon4| image:: https://img.shields.io/pypi/l/pymetadata.svg
-   :target: http://opensource.org/licenses/LGPL-3.0
-   :alt: GNU Lesser General Public License 3
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT License
 .. |icon5| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5308801.svg
    :target: https://doi.org/10.5281/zenodo.5308801
    :alt: Zenodo DOI
-.. |icon6| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://github.com/ambv/black
-   :alt: Black
-.. |icon7| image:: http://www.mypy-lang.org/static/mypy_badge.svg
+.. |icon6| image:: http://www.mypy-lang.org/static/mypy_badge.svg
    :target: http://mypy-lang.org/
    :alt: mypy
 
@@ -113,29 +101,12 @@ get started.
 
 License
 =======
-
-* Source Code: `LGPLv3 <http://opensource.org/licenses/LGPL-3.0>`__
-* Documentation: `CC BY-SA 4.0 <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
-The pymetadata source is released under both the GPL and LGPL licenses version 2 or
-later. You may choose which license you choose to use the software under.
-
-This program is free software: you can redistribute it and/or modify it under
-the terms of the GNU General Public License or the GNU Lesser General Public
-License as published by the Free Software Foundation, either version 2 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE. See the GNU General Public License for more details.
+* Source Code: `MIT <https://opensource.org/license/MIT>`__
+* Documentation: `CC BY-SA 4.0 <https://creativecommons.org/licenses/by-sa/4.0/>`__
 
 Funding
 =======
-Matthias König was supported by the Federal Ministry of Education and Research (BMBF, Germany)
-within the research network Systems Medicine of the Liver (**LiSyM**, grant number 031L0054) 
-and is supported by the German Research Foundation (DFG) within the Research Unit Programme FOR 5151 
-"`QuaLiPerF <https://qualiperf.de>`__ (Quantifying Liver Perfusion-Function Relationship in Complex Resection - 
-A Systems Medicine Approach)" by grant number 436883643 and by grant number 465194077 (Priority Programme SPP 2311, Subproject SimLivA), and 
+Matthias König (MK) was supported by the Federal Ministry of Education and Research (BMBF, Germany) within the research network Systems Medicine of the Liver (**LiSyM**, grant number 031L0054). MK is supported by the Federal Ministry of Education and Research (BMBF, Germany) within ATLAS by grant number 031L0304B and by the German Research Foundation (DFG) within the Research Unit Program FOR 5151 QuaLiPerF (Quantifying Liver Perfusion-Function Relationship in Complex Resection - A Systems Medicine Approach) by grant number 436883643 and by grant number 465194077 (Priority Programme SPP 2311, Subproject SimLivA).
 
 Installation
 ============
@@ -156,8 +127,28 @@ Or via cloning the repository and installing via::
     cd pymetadata
     pip install -e .
 
+
 To install for development use::
 
     pip install -e .[development]
 
-© 2021-2024 Matthias König
+
+Cache path
+==========
+`pymetadata` caches some information for faster retrieval. The cache path is set to::
+
+    CACHE_PATH: Path = Path.home() / ".cache" / "pymetadata"
+
+To use a custom cache path use::
+
+    import pymetadata
+    pymetadata.CACHE_PATH = <cache_path>
+
+
+Checks
+==========
+- uv for project setup
+- ruff for linting, formating
+- mypy for type checking
+
+© 2021-2025 Matthias König