diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7ff7065..123ddd8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,6 +4,4 @@ Please confirm that this pull request has done the following: -- [ ] Tests added -- [ ] Documentation added (where applicable) - [ ] Changelog item added to `changelog/` diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index da79d50..585b75a 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -58,7 +58,7 @@ jobs: uv build - name: Check build run: | - tar -tvf dist/mkdocstrings_python_accessors-*.tar.gz --wildcards '*mkdocstrings_python_accessors/py.typed' + tar -tvf dist/mkdocstrings_python_accessors-*.tar.gz --wildcards '*mkdocstrings_handlers/python_accessors/py.typed' tar -tvf dist/mkdocstrings_python_accessors-*.tar.gz --wildcards 'mkdocstrings_python_accessors-*/LICENCE' check-dependency-licences: diff --git a/.gitignore b/.gitignore index 5ab4442..e6e402d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ *.ipynb # Lock file -pdm.lock +uv.lock # Associated requirements file requirements.txt diff --git a/README.md b/README.md index 3daed8f..666b8a5 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,11 @@ Support for documenting accessors with mkdocstrings. **Key info :** -[![Docs](https://readthedocs.org/projects/mkdocstrings-python-accessors/badge/?version=latest)](https://mkdocstrings-python-accessors.readthedocs.io) [![Main branch: supported Python versions](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fclimate-resource%2Fmkdocstrings-python-accessors%2Fmain%2Fpyproject.toml)](https://github.com/climate-resource/mkdocstrings-python-accessors/blob/main/pyproject.toml) [![Licence](https://img.shields.io/pypi/l/mkdocstrings-python-accessors?label=licence)](https://github.com/climate-resource/mkdocstrings-python-accessors/blob/main/LICENCE) **PyPI :** [![PyPI](https://img.shields.io/pypi/v/mkdocstrings-python-accessors.svg)](https://pypi.org/project/mkdocstrings-python-accessors/) -[![PyPI install](https://github.com/climate-resource/mkdocstrings-python-accessors/actions/workflows/install-pypi.yaml/badge.svg?branch=main)](https://github.com/climate-resource/mkdocstrings-python-accessors/actions/workflows/install-pypi.yaml) **Tests :** [![CI](https://github.com/climate-resource/mkdocstrings-python-accessors/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/climate-resource/mkdocstrings-python-accessors/actions/workflows/ci.yaml) diff --git a/changelog/1.trivial.md b/changelog/1.trivial.md new file mode 100644 index 0000000..feb0d17 --- /dev/null +++ b/changelog/1.trivial.md @@ -0,0 +1 @@ +Initial release. diff --git a/pyproject.toml b/pyproject.toml index 6f2b79f..4b10fcc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,5 @@ [project] name = "mkdocstrings-python-accessors" -description = "A Python accessor handler for mkdocstrings." version = "0.1.0a1" description = "Support for documenting accessors with mkdocstrings." authors = [ @@ -52,6 +51,11 @@ dev = [ # ---------------- "liccheck==0.9.2", "mypy==1.14.0", + # Required for liccheck, see https://github.com/dhatim/python-license-check/pull/113 + "pip==24.3.1", + "pre-commit==4.0.1", + # Required for liccheck, see https://github.com/dhatim/python-license-check/pull/113 + "setuptools==75.6.0", "towncrier==24.8.0", ] all-dev = [ @@ -165,6 +169,8 @@ authorized_licenses = [ "Apache License, Version 2.0", "CMU License (MIT-CMU)", "Historical Permission Notice and Disclaimer (HPND)", + # TODO: push upstream + "isc", "isc license", "isc license (iscl)", "gnu lgpl", @@ -190,3 +196,6 @@ unauthorized_licenses = [ "gpl v1", "gplv1", ] +[tool.liccheck.authorized_packages] +# Apache, just mislabelled (see https://github.com/analog-garage/mkdocstrings-python-xref/blob/main/LICENSE.md) +mkdocstrings-python-xref = "1.*"