11[project ]
22name = " mkdocstrings-python-accessors"
3- version = " 0.3.4a1"
43description = " A Python accessor handler for mkdocstrings."
5- authors = [{name = " Zebedee Nicholls" , email = " zebedee.nicholls@climate-resource.com" }]
4+ version = " 0.1.0a1"
5+ description = " Support for documenting accessors with mkdocstrings."
6+ authors = [
7+ { name = " Zebedee Nicholls" , email = " zebedee.nicholls@climate-resource.com" },
8+ ]
69license = {text = " BSD-3-Clause" }
7- readme = " README.md"
810requires-python = " >=3.9"
9- keywords = []
11+ dependencies = [
12+ " mkdocstrings-python-xref>=1.0" ,
13+ ]
14+ readme = " README.md"
1015classifiers = [
1116 # TODO: pull some of these across into our copier template
17+ " License :: OSI Approved :: BSD License" ,
1218 " Development Status :: 4 - Beta" ,
1319 " Intended Audience :: Developers" ,
1420 " Programming Language :: Python" ,
@@ -24,9 +30,6 @@ classifiers = [
2430 " Topic :: Utilities" ,
2531 " Typing :: Typed" ,
2632]
27- dependencies = [
28- " mkdocstrings-python-xref>=1.0" ,
29- ]
3033
3134# TODO: pull into our copier template
3235[project .urls ]
@@ -37,13 +40,35 @@ Repository = "https://github.com/climate-resource/mkdocstrings-python-accessors"
3740Issues = " https://github.com/climate-resource/mkdocstrings-python-accessors/issues"
3841Discussions = " https://github.com/climate-resource/mkdocstrings-python-accessors/discussions"
3942
43+ [project .optional-dependencies ]
44+
45+ [dependency-groups ]
46+ # The development dependencies are pinned
47+ # to give a consistent starting point when using this template.
48+ # They should be removed/updated/changed/loosened as suits your project.
49+ # (As soon as you have a lock file, you can remove all of the implied dependencies.)
50+ dev = [
51+ # Key dependencies
52+ # ----------------
53+ " liccheck==0.9.2" ,
54+ " mypy==1.14.0" ,
55+ " towncrier==24.8.0" ,
56+ ]
57+ all-dev = [
58+ {include-group = " dev" },
59+ ]
60+
4061[build-system ]
41- requires = [" pdm-backend" ]
62+ requires = [
63+ " pdm-backend" ,
64+ ]
4265build-backend = " pdm.backend"
4366
67+ [tool .pdm ]
4468[tool .pdm .build ]
45- package-dir = " src"
46- includes = [" src/mkdocstrings_handlers" ]
69+ includes = [
70+ " src/mkdocstrings_handlers" ,
71+ ]
4772# Consider adding something like this to our copier template.
4873# Include as much as possible in the source distribution, to help redistributors.
4974excludes = [" **/.pytest_cache" ]
@@ -55,3 +80,113 @@ source-includes = [
5580 # "*.md",
5681 " LICENCE" ,
5782]
83+
84+ [tool .mypy ]
85+ strict = true
86+ disallow_any_unimported = true
87+ show_error_codes = true
88+ show_error_context = true
89+ warn_unreachable = true
90+ follow_imports = " normal"
91+
92+ [tool .ruff ]
93+ src = [
94+ " src" ,
95+ ]
96+ target-version = " py39"
97+ line-length = 88
98+
99+ [tool .ruff .lint ]
100+ select = [
101+ " E" ,
102+ " W" ,
103+ " F" ,
104+ " I" ,
105+ " D" ,
106+ " PL" ,
107+ " TRY" ,
108+ " NPY" ,
109+ " RUF" ,
110+ " UP" ,
111+ " S" ,
112+ ]
113+ unfixable = [
114+ " PD002" ,
115+ ]
116+ ignore = [
117+ " D200" ,
118+ " D400" ,
119+ " UP007" ,
120+ ]
121+
122+ [tool .ruff .lint .isort ]
123+ known-first-party = [
124+ " src" ,
125+ ]
126+
127+ [tool .ruff .lint .pydocstyle ]
128+ convention = " numpy"
129+
130+ [tool .ruff .format ]
131+ docstring-code-format = true
132+
133+ [tool .towncrier ]
134+ package = " mkdocstrings_python_accessors"
135+ package_dir = " src"
136+ filename = " docs/changelog.md"
137+ directory = " changelog/"
138+ title_format = " ## mkdocstrings-python-accessors {version} ({project_date})"
139+ underlines = [
140+ " " ,
141+ " " ,
142+ " " ,
143+ ]
144+ issue_format = " [#{issue}](https://github.com/climate-resource/mkdocstrings-python-accessors/pull/{issue})"
145+ type = [
146+ { directory = " breaking" , name = " ⚠️ Breaking Changes" , showcontent = true },
147+ { directory = " deprecation" , name = " 🗑️ Deprecations" , showcontent = true },
148+ { directory = " feature" , name = " 🆕 Features" , showcontent = true },
149+ { directory = " improvement" , name = " 🎉 Improvements" , showcontent = true },
150+ { directory = " fix" , name = " 🐛 Bug Fixes" , showcontent = true },
151+ { directory = " docs" , name = " 📚 Improved Documentation" , showcontent = true },
152+ { directory = " trivial" , name = " 🔧 Trivial/Internal Changes" , showcontent = false },
153+ ]
154+
155+ [tool .liccheck ]
156+ authorized_licenses = [
157+ " bsd" ,
158+ " bsd license" ,
159+ " BSD 3-Clause" ,
160+ " CC0" ,
161+ " apache" ,
162+ " apache 2.0" ,
163+ " apache software" ,
164+ " apache software license" ,
165+ " Apache License, Version 2.0" ,
166+ " CMU License (MIT-CMU)" ,
167+ " Historical Permission Notice and Disclaimer (HPND)" ,
168+ " isc license" ,
169+ " isc license (iscl)" ,
170+ " gnu lgpl" ,
171+ " lgpl with exceptions or zpl" ,
172+ " LGPLv2+" ,
173+ " GNU Lesser General Public License v2 (LGPLv2)" ,
174+ " GNU Lesser General Public License v2 or later (LGPLv2+)" ,
175+ " mit" ,
176+ " mit license" ,
177+ " Mozilla Public License 2.0 (MPL 2.0)" ,
178+ " python software foundation" ,
179+ " python software foundation license" ,
180+ " The Unlicense (Unlicense)" ,
181+ " zpl 2.1" ,
182+ ]
183+ unauthorized_licenses = [
184+ " agpl" ,
185+ " gnu agpl" ,
186+ " gpl v3" ,
187+ " gplv3" ,
188+ " gpl v2" ,
189+ " gplv2" ,
190+ " gpl v1" ,
191+ " gplv1" ,
192+ ]
0 commit comments