pydantic-pint 0.1__tar.gz

pydantic_pint-0.1/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+mkdocs:
+  configuration: mkdocs.yaml

pydantic_pint-0.1/CHANGES.md

@@ -0,0 +1,14 @@
+# Changes
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased](https://github.com/tylerh111/pydantic-pint/compare/0.0...main)
+
+<!-- release notes -->
+
+## [0.1](https://github.com/tylerh111/pydantic-pint/releases/tag/0.1) - 2024-05-06
+
+
+### Features
+
+- Added initial code, docs, and tools.

pydantic_pint-0.1/CONTRIBUTING.md

@@ -0,0 +1,136 @@
+# Contributing
+
+Thank you for taking the time to contribute to Pydantic Pint!
+All types of contributions are encouraged and valued.
+Please refer to this page for ways to contribute.
+
+## Overview
+
+> There are plenty of ways to support the project and show your appreciation!
+>
+> - Create and comment on [issues].
+> - Create and comment on [pull requests].
+> - [Fork] the project.
+> - [Star] the project.
+> - [Watch] the project.
+> - Talk about the project!
+
+## Creating Issues
+
+GitHub [issues] track any enhancements, bugs, questions, or suggestions for this project.
+
+- [Open an issue].
+- Provide as much detail as you can.
+- Provide project and platform version (python, pydantic, pint, etc.).
+
+#### Asking Questions
+
+If you have a question, create an issue with the `question` label.
+We will try to answer it as best we can.
+
+Provide the following information when asking questions.
+
+- Ask the question in a clear and concise manner.
+- Search and link relevant issues and pull requests.
+- Provide details and context separate from the question.
+  In other words, the question and context should be separate.
+  This makes it easier to answer the question if it is clearly stated.
+  Anything passed that can be a discussion.
+
+#### Requesting Features
+
+If you have an idea for enhancements, open an issue with the `enhancement` label.
+We will determine if such an enhancement is worth implementing.
+Enhancements should improve the use of the project without breaking the existing functionality.
+
+Provide the following information when requesting features.
+
+- Explain what currently does not exist with the project.
+- Explain how the feature request can address the issue.
+- Include usecases for the feature.
+- Include examples for using the feature.
+
+#### Reporting Bugs
+
+If you find a bug, open an issue with the `bug` label.
+Bug reports should contain information about the environment in which you are running.
+This is key in order to replicate the issue to further investigate and fix it.
+
+Provide the following information when reporting a bug.
+
+- Environment, including project and platform information (python, pydantic, pint, etc.).
+- Current behavior, include examples for replication.
+- Expected behavior, include examples for verification.
+
+#### Updating Documentation
+
+If you think the documentation should be updated, open an issue with the `documentation` label.
+Documentation might have small issues that need fixed, e.g. misspellings or grammar mistakes, or might be related to enhancements or bugs, e.g. new or changed functionality.
+
+Provide the following information when updating the documentation.
+
+- The documentation page that should be added.
+- The documentation page that should be modified.
+- The documentation page that should be removed.
+- Updates to examples.
+
+## Creating Pull Requests
+
+GitHub [pull requests] address the issues of the project.
+
+- [Fork] the project.
+- Create a branch from the latest revision on `main`.
+- Implement the changes to address a particular issue(s).
+- [Open a pull request].
+- Add the issue number to the description of the pull request.
+  It should be clear which issue (or issues) are addressed.
+
+#### Fixing Bugs
+
+Fixing a bug should have an associated issue labeled as a `bug`.
+Make sure the bug is fixed correctly and completely.
+The following additions to your bugfix could help improve it.
+
+- Add unit tests to cover the bugfix.
+  This ensures that it never pops back up.
+- Test all facets of your changes so that no other parts of the code base breaks.
+  Check how the new feature interacts with other features.
+- Make sure each commit is deliberate and meaningful.
+  Changes like spacing, formatting, or typos (in unrelated locations) are not necessary to change while implementing a feature or bugfix.
+  Ensure other parts of the code have not been modified that do not need to be modified to implement your feature or bugfix.
+- Limit the size of your changes.
+  Large diffs can be difficult to verify and validate.
+
+#### Implementing Features
+
+Implementing a feature should have an associated issue labeled as an `enhancement`.
+Make sure the feature is implemented correctly and completely.
+The following additions to your feature could help improve it.
+
+- Add documentation.
+- Add unit tests.
+  Check corner cases, and how the feature works with bad or invalid input.
+- Test all facets of your changes so that no other parts of the code base breaks.
+  Check how the new feature interacts with other features.
+- Make sure each commit is deliberate and meaningful.
+  Changes like spacing, formatting, or typos (in unrelated locations) are not necessary to change while implementing a feature or bugfix.
+  Ensure other parts of the code have not been modified that do not need to be modified to implement your feature or bugfix.
+- Limit the size of your changes.
+  Large diffs can be difficult to verify and validate.
+
+
+## Thank You!
+
+You are help Pydantic Pint grow and prosper with your involvement.
+We hope to see your contributions in the project soon!
+
+<!-- links -->
+[project]:             https://github.com/tylerh111/pydantic-pint
+[star]:                https://github.com/tylerh111/pydantic-pint
+[watch]:               https://github.com/tylerh111/pydantic-pint
+[fork]:                https://github.com/tylerh111/pydantic-pint/fork
+[issues]:              https://github.com/tylerh111/pydantic-pint/issues
+[open an issue]:       https://github.com/tylerh111/pydantic-pint/issues/new
+[pull requests]:       https://github.com/tylerh111/pydantic-pint/pulls
+[open a pull request]: https://github.com/tylerh111/pydantic-pint/compare
+[documentation]:       https://pydantic-pint.readthedocs.io

pydantic_pint-0.1/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tyler Hughes
+
+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.

pydantic_pint-0.1/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.1
+Name: pydantic-pint
+Version: 0.1
+Summary: Pydantic validation for Pint Quantities.
+Author-email: Tyler Hughes <tylerxh111+git@proton.me>
+License: MIT License
+        
+        Copyright (c) 2024 Tyler Hughes
+        
+        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.
+        
+Project-URL: source, https://github.com/tylerh111/pydantic-pint
+Project-URL: issues, https://github.com/tylerh111/pydantic-pint/issues
+Project-URL: changes, https://github.com/tylerh111/pydantic-pint/blob/main/CHANGES.md
+Project-URL: documentation, https://pydantic-pint.readthedocs.io
+Keywords: pydantic-pint,pydantic,pint
+Classifier: Development Status :: 1 - Planning
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pydantic :: 2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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 :: Only
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pint>=0.20
+Requires-Dist: pydantic>=2.0
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: bumpver; extra == "build"
+Requires-Dist: setuptools>=61; extra == "build"
+Requires-Dist: setuptools-scm; extra == "build"
+Requires-Dist: towncrier; extra == "build"
+Requires-Dist: twine; extra == "build"
+Provides-Extra: dev
+Requires-Dist: nox; extra == "dev"
+Requires-Dist: setuptools-scm; extra == "dev"
+Requires-Dist: pydantic-pint[build,docs,lint,tests]; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mike; extra == "docs"
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-exclude; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocs-material-extensions; extra == "docs"
+Requires-Dist: mkdocs-minify-plugin; extra == "docs"
+Requires-Dist: mkdocs-redirects; extra == "docs"
+Requires-Dist: mkdocstrings; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: pygments; extra == "docs"
+Requires-Dist: pymdown-extensions; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: ruff; extra == "lint"
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+
+# Pydantic Pint
+
+[![_](https://img.shields.io/pypi/v/pydantic-pint)](https://pypi.python.org/pypi/pydantic-pint)
+[![_](https://img.shields.io/pypi/pyversions/pydantic-pint)](https://github.com/tylerh111/pydantic-pint)
+[![_](https://img.shields.io/pypi/l/pydantic-pint)](https://github.com/tylerh111/pydantic-pint/blob/main/LICENSE.md)
+[![_](https://img.shields.io/readthedocs/pydantic-pint)](https://pydantic-pint.readthedocs.io)
+
+---
+
+[Pydantic](https://docs.pydantic.dev) is a Python library for data validation and data serialization.
+[Pint](https://pint.readthedocs.io) is a Python library for defining, operating, and manipulating physical quantities.
+By default, they do not play well with each other.
+
+Many projects that have a need for data validation may also need to work with physical quantities.
+[Pydantic Pint](https://pydantic-pint.readthedocs.io) aims to bridge that gap by providing Pydantic validation for Pint quantities.
+
+```python
+from pydantic import BaseModel
+from pydantic_pint import PydanticPintQuantity
+from pint import Quantity
+from typing import Annotations
+
+class Box(BaseModel):
+    length: Annotated[Quantity, PydanticPintQuantity("m")]
+    width: Annotated[Quantity, PydanticPintQuantity("m")]
+
+box = Box(
+    length="4m",
+    width="2m",
+)
+```
+
+## Getting Started
+
+### Installation
+
+Pydantic Pint is available as [`pydantic-pint`](https://pypi.python.org/pypi/pydantic-pint) on PyPI.
+
+Pydantic Pint requires both Pydantic and Pint to be installed.
+It also requires [`typing.Annotated`](https://docs.python.org/3/library/typing.html#typing.Annotated) (for older version of python use [`typing-extensions`](https://pypi.org/project/typing-extensions/)).
+
+```shell
+pip install pydantic-pint
+```
+
+### Usage
+
+Pydantic Pint provides `PydanticPintQuantity` which enabled Pydantic validation for Pint quantities.
+For a field of a Pydantic model to have quantity validation, it must be annotated with a `PydanticPintQuantity` for a given unit.
+
+```python
+from pydantic import BaseModel
+from pydantic_pint import PydanticPintQuantity
+from pint import Quantity
+from typing import Annotated
+
+class Coordinates(BaseModel):
+    latitude: Annotated[Quantity, PydanticPintQuantity("deg")]
+    longitude: Annotated[Quantity, PydanticPintQuantity("deg")]
+    altitude: Annotated[Quantity, PydanticPintQuantity("km")]
+```
+
+Users of the model can input anything to the field with a specified unit that is convertible to the units declared in the annotation.
+For instance, the units for `Coordinates.altitude` are kilometers, however users can specify meters instead.
+`PydanticPintQuantity` will handle the conversion from meters to kilometers.
+
+```python
+coord = Coordinates(
+    latitude="39.905705 deg",
+    longitude="-75.166519 deg",
+    altitude="12 meters",
+)
+
+print(coord)
+#> latitude=<Quantity(39.905705, 'degree')> longitude=<Quantity(-75.166519, 'degree')> altitude=<Quantity(0.012, 'kilometer')>
+print(f"{coord!r}")
+#> Coordinates(latitude=<Quantity(39.905705, 'degree')>, longitude=<Quantity(-75.166519, 'degree')>, altitude=<Quantity(0.012, 'kilometer')>)
+print(coord.model_dump())
+#> {'latitude': <Quantity(39.905705, 'degree')>, 'longitude': <Quantity(-75.166519, 'degree')>, 'altitude': <Quantity(0.012, 'kilometer')>}
+print(coord.model_dump(mode="json"))
+#> {'latitude': '39.905705 degree', 'longitude': '-75.166519 degree', 'altitude': '0.012 kilometer'}
+print(f"{coord.model_dump_json()!r}")
+#> '{"latitude":"39.905705 degree","longitude":"-75.166519 degree","altitude":"0.012 kilometer"}'
+```

pydantic_pint-0.1/README.md

@@ -0,0 +1,84 @@
+# Pydantic Pint
+
+[![_](https://img.shields.io/pypi/v/pydantic-pint)](https://pypi.python.org/pypi/pydantic-pint)
+[![_](https://img.shields.io/pypi/pyversions/pydantic-pint)](https://github.com/tylerh111/pydantic-pint)
+[![_](https://img.shields.io/pypi/l/pydantic-pint)](https://github.com/tylerh111/pydantic-pint/blob/main/LICENSE.md)
+[![_](https://img.shields.io/readthedocs/pydantic-pint)](https://pydantic-pint.readthedocs.io)
+
+---
+
+[Pydantic](https://docs.pydantic.dev) is a Python library for data validation and data serialization.
+[Pint](https://pint.readthedocs.io) is a Python library for defining, operating, and manipulating physical quantities.
+By default, they do not play well with each other.
+
+Many projects that have a need for data validation may also need to work with physical quantities.
+[Pydantic Pint](https://pydantic-pint.readthedocs.io) aims to bridge that gap by providing Pydantic validation for Pint quantities.
+
+```python
+from pydantic import BaseModel
+from pydantic_pint import PydanticPintQuantity
+from pint import Quantity
+from typing import Annotations
+
+class Box(BaseModel):
+    length: Annotated[Quantity, PydanticPintQuantity("m")]
+    width: Annotated[Quantity, PydanticPintQuantity("m")]
+
+box = Box(
+    length="4m",
+    width="2m",
+)
+```
+
+## Getting Started
+
+### Installation
+
+Pydantic Pint is available as [`pydantic-pint`](https://pypi.python.org/pypi/pydantic-pint) on PyPI.
+
+Pydantic Pint requires both Pydantic and Pint to be installed.
+It also requires [`typing.Annotated`](https://docs.python.org/3/library/typing.html#typing.Annotated) (for older version of python use [`typing-extensions`](https://pypi.org/project/typing-extensions/)).
+
+```shell
+pip install pydantic-pint
+```
+
+### Usage
+
+Pydantic Pint provides `PydanticPintQuantity` which enabled Pydantic validation for Pint quantities.
+For a field of a Pydantic model to have quantity validation, it must be annotated with a `PydanticPintQuantity` for a given unit.
+
+```python
+from pydantic import BaseModel
+from pydantic_pint import PydanticPintQuantity
+from pint import Quantity
+from typing import Annotated
+
+class Coordinates(BaseModel):
+    latitude: Annotated[Quantity, PydanticPintQuantity("deg")]
+    longitude: Annotated[Quantity, PydanticPintQuantity("deg")]
+    altitude: Annotated[Quantity, PydanticPintQuantity("km")]
+```
+
+Users of the model can input anything to the field with a specified unit that is convertible to the units declared in the annotation.
+For instance, the units for `Coordinates.altitude` are kilometers, however users can specify meters instead.
+`PydanticPintQuantity` will handle the conversion from meters to kilometers.
+
+```python
+coord = Coordinates(
+    latitude="39.905705 deg",
+    longitude="-75.166519 deg",
+    altitude="12 meters",
+)
+
+print(coord)
+#> latitude=<Quantity(39.905705, 'degree')> longitude=<Quantity(-75.166519, 'degree')> altitude=<Quantity(0.012, 'kilometer')>
+print(f"{coord!r}")
+#> Coordinates(latitude=<Quantity(39.905705, 'degree')>, longitude=<Quantity(-75.166519, 'degree')>, altitude=<Quantity(0.012, 'kilometer')>)
+print(coord.model_dump())
+#> {'latitude': <Quantity(39.905705, 'degree')>, 'longitude': <Quantity(-75.166519, 'degree')>, 'altitude': <Quantity(0.012, 'kilometer')>}
+print(coord.model_dump(mode="json"))
+#> {'latitude': '39.905705 degree', 'longitude': '-75.166519 degree', 'altitude': '0.012 kilometer'}
+print(f"{coord.model_dump_json()!r}")
+#> '{"latitude":"39.905705 degree","longitude":"-75.166519 degree","altitude":"0.012 kilometer"}'
+```

pydantic_pint-0.1/changes/.gitignore

@@ -0,0 +1 @@
+!.gitignore

pydantic_pint-0.1/docs/api/quantity.md

@@ -0,0 +1,2 @@
+
+::: pydantic_pint.quantity

pydantic_pint-0.1/docs/index.md

@@ -0,0 +1,84 @@
+# Pydantic Pint
+
+[![_](https://img.shields.io/pypi/v/pydantic-pint)](https://pypi.python.org/pypi/pydantic-pint)
+[![_](https://img.shields.io/pypi/pyversions/pydantic-pint)](https://github.com/tylerh111/pydantic-pint)
+[![_](https://img.shields.io/pypi/l/pydantic-pint)](https://github.com/tylerh111/pydantic-pint/blob/main/LICENSE.md)
+[![_](https://img.shields.io/readthedocs/pydantic-pint)](https://pydantic-pint.readthedocs.io)
+
+---
+
+[Pydantic](https://docs.pydantic.dev) is a Python library for data validation and data serialization.
+[Pint](https://pint.readthedocs.io) is a Python library for defining, operating, and manipulating physical quantities.
+By default, they do not play well with each other.
+
+Many projects that have a need for data validation may also need to work with physical quantities.
+[Pydantic Pint](https://pydantic-pint.readthedocs.io) aims to bridge that gap by providing Pydantic validation for Pint quantities.
+
+```python
+from pydantic import BaseModel
+from pydantic_pint import PydanticPintQuantity
+from pint import Quantity
+from typing import Annotations
+
+class Box(BaseModel):
+    length: Annotated[Quantity, PydanticPintQuantity("m")]
+    width: Annotated[Quantity, PydanticPintQuantity("m")]
+
+box = Box(
+    length="4m",
+    width="2m",
+)
+```
+
+## Getting Started
+
+### Installation
+
+Pydantic Pint is available as [`pydantic-pint`](https://pypi.python.org/pypi/pydantic-pint) on PyPI.
+
+Pydantic Pint requires both Pydantic and Pint to be installed.
+It also requires [`typing.Annotated`](https://docs.python.org/3/library/typing.html#typing.Annotated) (for older version of python use [`typing_extensions`](https://pypi.org/project/typing-extensions/)).
+
+```shell
+pip install pydantic-pint
+```
+
+### Usage
+
+Pydantic Pint provides `PydanticPintQuantity` which enabled Pydantic validation for Pint quantities.
+For a field of a Pydantic model to have quantity validation, it must be annotated with a `PydanticPintQuantity` for a given unit.
+
+```python
+from pydantic import BaseModel
+from pydantic_pint import PydanticPintQuantity
+from pint import Quantity
+from typing import Annotated
+
+class Coordinates(BaseModel):
+    latitude: Annotated[Quantity, PydanticPintQuantity("deg")]
+    longitude: Annotated[Quantity, PydanticPintQuantity("deg")]
+    altitude: Annotated[Quantity, PydanticPintQuantity("km")]
+```
+
+Users of the model can input anything to the field with a specified unit that is convertible to the units declared in the annotation.
+For instance, the units for `Coordinates.altitude` are kilometers, however users can specify meters instead.
+`PydanticPintQuantity` will handle the conversion from meters to kilometers.
+
+```python
+coord = Coordinates(
+    latitude="39.905705 deg",
+    longitude="-75.166519 deg",
+    altitude="12 meters",
+)
+
+print(coord)
+#> latitude=<Quantity(39.905705, 'degree')> longitude=<Quantity(-75.166519, 'degree')> altitude=<Quantity(0.012, 'kilometer')>
+print(f"{coord!r}")
+#> Coordinates(latitude=<Quantity(39.905705, 'degree')>, longitude=<Quantity(-75.166519, 'degree')>, altitude=<Quantity(0.012, 'kilometer')>)
+print(coord.model_dump())
+#> {'latitude': <Quantity(39.905705, 'degree')>, 'longitude': <Quantity(-75.166519, 'degree')>, 'altitude': <Quantity(0.012, 'kilometer')>}
+print(coord.model_dump(mode="json"))
+#> {'latitude': '39.905705 degree', 'longitude': '-75.166519 degree', 'altitude': '0.012 kilometer'}
+print(f"{coord.model_dump_json()!r}")
+#> '{"latitude":"39.905705 degree","longitude":"-75.166519 degree","altitude":"0.012 kilometer"}'
+```

pydantic_pint-0.1/docs/overrides/partials/toc-item.html

@@ -0,0 +1,21 @@
+<!-- Table of contents item -->
+<li class="md-nav__item">
+  <a href="{{ toc_item.url }}" class="md-nav__link">
+    <span class="md-ellipsis">
+      {{ toc_item.title }}
+    </span>
+  </a>
+
+  <!-- Table of contents list -->
+  {% if toc_item.children %}
+    <nav class="md-nav" aria-label="{{ toc_item.title | striptags }}">
+      <ul class="md-nav__list">
+        {% for toc_item in toc_item.children %}
+        {% if not page.meta.toc_depth or toc_item.level <= page.meta.toc_depth %}
+          {% include "partials/toc-item.html" %}
+          {% endif %}
+        {% endfor %}
+      </ul>
+    </nav>
+  {% endif %}
+</li>

pydantic_pint-0.1/docs/plugins/fetch_project_files.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+import logging
+import textwrap
+from pathlib import Path
+
+from mkdocs.config import Config
+
+logger = logging.getLogger("mkdocs.plugin")
+
+ROOT = Path(__file__).parents[2]
+DOCS = ROOT / "docs"
+
+
+def on_pre_build(config: Config):
+    """Before build starts."""
+    _add_tracked_file(
+        ROOT / "CHANGES.md",
+        DOCS / "changes.md",
+        prepend=(
+            """
+            ---
+            toc_depth: 2
+            ---
+            """
+        ),
+    )
+    _add_tracked_file(
+        ROOT / "CONTRIBUTING.md",
+        DOCS / "contributing.md",
+    )
+    _add_tracked_file(
+        ROOT / "LICENSE.md",
+        DOCS / "license.md",
+    )
+
+
+def _add_tracked_file(
+    file: Path,
+    new_file: Path,
+    prepend: str = "",
+    append: str = "",
+):
+    prepend = prepend.lstrip("\n") + "\n" if prepend else ""
+    append = append.lstrip("\n") + "\n" if append else ""
+
+    text = file.read_text(encoding="utf-8")
+    text = "".join(
+        (
+            textwrap.dedent(prepend),
+            text,
+            textwrap.dedent(append),
+        )
+    )
+
+    # avoid writing file unless the content has changed to avoid infinite build loop
+    if not new_file.is_file() or new_file.read_text(encoding="utf-8") != text:
+        new_file.write_text(text, encoding="utf-8")