From 6c568aa1a29288229d2667ebdf8085938cf40270 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:33:36 +0100 Subject: [PATCH 1/9] Fix up pyproject.toml file --- pyproject.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 6f2b79f..bfe85f9 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 = [ From 2398e24365a29c9e5983ecc7693d1acea5b03bd1 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:34:02 +0100 Subject: [PATCH 2/9] Simplify PR template --- .github/pull_request_template.md | 2 -- 1 file changed, 2 deletions(-) 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/` From 3d30f11c585c85d54127c28ae0bfe1a94e9ff40c Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:34:38 +0100 Subject: [PATCH 3/9] CHANGELOG --- changelog/1.trivial.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog/1.trivial.md 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. From ef541c310b988ecce51ffd2da99411cfc343a804 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:35:41 +0100 Subject: [PATCH 4/9] Remove dead links in README --- README.md | 2 -- 1 file changed, 2 deletions(-) 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) From 1af320492f64b14c40268bc015706063226dd81d Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:37:23 +0100 Subject: [PATCH 5/9] Fix up other deps --- .github/workflows/ci.yaml | 2 +- pyproject.toml | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) 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/pyproject.toml b/pyproject.toml index bfe85f9..337c565 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,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 = [ From 22daa4d311de1c87c06b554968852315c2672934 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:40:30 +0100 Subject: [PATCH 6/9] Clarify xref licence --- pyproject.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 337c565..76f0038 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -194,3 +194,6 @@ unauthorized_licenses = [ "gpl v1", "gplv1", ] +[Authorized Packages] +# Apache, just mislabelled (see https://github.com/analog-garage/mkdocstrings-python-xref/blob/main/LICENSE.md) +mkdocstrings-python-xref From 7131c90821dcf51ff98dcef4dc8f809f6c23be17 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:41:50 +0100 Subject: [PATCH 7/9] Try again --- pyproject.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 76f0038..91aa715 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -194,6 +194,6 @@ unauthorized_licenses = [ "gpl v1", "gplv1", ] -[Authorized Packages] +[tool.liccheck.authorized_packages] # Apache, just mislabelled (see https://github.com/analog-garage/mkdocstrings-python-xref/blob/main/LICENSE.md) -mkdocstrings-python-xref +mkdocstrings-python-xref = "1.0.*" From 9ecf7bfd365b3a023a4da385a118ceecc0f88bfd Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 14:46:12 +0100 Subject: [PATCH 8/9] One more time --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 91aa715..f0c4a4e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -196,4 +196,4 @@ unauthorized_licenses = [ ] [tool.liccheck.authorized_packages] # Apache, just mislabelled (see https://github.com/analog-garage/mkdocstrings-python-xref/blob/main/LICENSE.md) -mkdocstrings-python-xref = "1.0.*" +mkdocstrings-python-xref = "1.*" From 8bf7099278fcfe0038348774ae3142f1e1923d6a Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Fri, 17 Jan 2025 15:12:42 +0100 Subject: [PATCH 9/9] Fix up licence allowed list --- .gitignore | 2 +- pyproject.toml | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) 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/pyproject.toml b/pyproject.toml index f0c4a4e..4b10fcc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -169,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",