mkdocs-spellcheck 1.2.1__tar.gz → 1.2.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mkdocs_spellcheck-1.2.2/AI_POLICY.md +15 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/CHANGELOG.md +8 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/CONTRIBUTING.md +6 -16
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/LICENSE +1 -1
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/PKG-INFO +7 -10
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/README.md +3 -6
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/git-changelog.toml +1 -1
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/ruff.toml +8 -23
- mkdocs_spellcheck-1.2.2/config/ty.toml +6 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/vscode/launch.json +1 -2
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/vscode/settings.json +1 -3
- mkdocs_spellcheck-1.2.2/config/zed/debug.json +44 -0
- mkdocs_spellcheck-1.2.2/config/zed/settings.json +43 -0
- mkdocs_spellcheck-1.2.2/config/zed/tasks.json +72 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/.overrides/partials/comments.html +1 -1
- mkdocs_spellcheck-1.2.2/docs/css/apidocs.css +21 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/duties.py +78 -18
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/pyproject.toml +10 -16
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/scripts/gen_credits.py +34 -23
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/scripts/get_version.py +18 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/scripts/make.py +36 -10
- mkdocs_spellcheck-1.2.2/src/mkdocs_spellcheck/__init__.py +39 -0
- mkdocs_spellcheck-1.2.2/src/mkdocs_spellcheck/_internal/__init__.py +17 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/src/mkdocs_spellcheck/_internal/backends/__init__.py +18 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/src/mkdocs_spellcheck/_internal/backends/codespell.py +19 -1
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/src/mkdocs_spellcheck/_internal/backends/symspellpy.py +18 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/src/mkdocs_spellcheck/_internal/debug.py +19 -1
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/src/mkdocs_spellcheck/_internal/plugin.py +18 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/src/mkdocs_spellcheck/_internal/words.py +18 -0
- mkdocs_spellcheck-1.2.2/src/mkdocs_spellcheck/backends/__init__.py +35 -0
- mkdocs_spellcheck-1.2.2/src/mkdocs_spellcheck/backends/codespell.py +35 -0
- mkdocs_spellcheck-1.2.2/src/mkdocs_spellcheck/backends/symspellpy.py +35 -0
- mkdocs_spellcheck-1.2.2/src/mkdocs_spellcheck/plugin.py +35 -0
- mkdocs_spellcheck-1.2.2/src/mkdocs_spellcheck/words.py +35 -0
- mkdocs_spellcheck-1.2.2/tests/__init__.py +25 -0
- mkdocs_spellcheck-1.2.2/tests/conftest.py +19 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/tests/test_api.py +23 -5
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/tests/test_words.py +18 -0
- mkdocs_spellcheck-1.2.2/zensical.toml +186 -0
- mkdocs_spellcheck-1.2.1/mkdocs.yml +0 -181
- mkdocs_spellcheck-1.2.1/src/mkdocs_spellcheck/__init__.py +0 -21
- mkdocs_spellcheck-1.2.1/src/mkdocs_spellcheck/_internal/__init__.py +0 -0
- mkdocs_spellcheck-1.2.1/src/mkdocs_spellcheck/backends/__init__.py +0 -17
- mkdocs_spellcheck-1.2.1/src/mkdocs_spellcheck/backends/codespell.py +0 -17
- mkdocs_spellcheck-1.2.1/src/mkdocs_spellcheck/backends/symspellpy.py +0 -17
- mkdocs_spellcheck-1.2.1/src/mkdocs_spellcheck/plugin.py +0 -17
- mkdocs_spellcheck-1.2.1/src/mkdocs_spellcheck/words.py +0 -17
- mkdocs_spellcheck-1.2.1/tests/__init__.py +0 -7
- mkdocs_spellcheck-1.2.1/tests/conftest.py +0 -1
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/CODE_OF_CONDUCT.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/coverage.ini +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/mypy.ini +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/pytest.ini +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/config/vscode/tasks.json +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/.overrides/partials/path-item.html +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/changelog.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/code_of_conduct.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/contributing.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/credits.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/css/material.css +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/css/mkdocstrings.css +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/index.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/js/feedback.js +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/known_words.txt +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/license.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/reference/api.md +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/docs/schema.json +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/scripts/make +0 -0
- {mkdocs_spellcheck-1.2.1 → mkdocs_spellcheck-1.2.2}/src/mkdocs_spellcheck/py.typed +0 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# AI Contribution Policy
|
|
2
|
+
|
|
3
|
+
We accept AI-*assisted* contributions, both for code and documentation, with the following expectations:
|
|
4
|
+
|
|
5
|
+
- AI-assisted contributions must disclaim their use of AI.
|
|
6
|
+
- Contributors must fully understand the proposed changes and be able to explain why they are the correct approach.
|
|
7
|
+
- Issues must be created before creating pull requests (unless there is already a relevant issue).
|
|
8
|
+
- Issue and pull request templates must be followed.
|
|
9
|
+
- Comments (including bodies) in issues and pull requests must be written by humans. If you use LLMs to translate from one language to another, please include your original comment and the translated one.
|
|
10
|
+
- Git commits must be authored by humans, not AI/bot accounts or identities.
|
|
11
|
+
- Git commit messages must be written by humans, in English. If you cannot write English, please state so in the pull request body and we will write the commit messages ourselves.
|
|
12
|
+
|
|
13
|
+
Failure to comply with any of these requirements will result in issues or pull requests being closed immediately without comment. Repeated violations of this policy will result in a ban of the offending accounts/identities from contributing to this project and any related project from the same author/organization.
|
|
14
|
+
|
|
15
|
+
We do not accept AI-generated content in community spaces we maintain or moderate, such as GitHub discussions or Matrix rooms.
|
|
@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
|
5
5
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
7
|
<!-- insertion marker -->
|
|
8
|
+
## [1.2.2](https://github.com/pawamoy/mkdocs-spellcheck/releases/tag/1.2.2) - 2026-10-06
|
|
9
|
+
|
|
10
|
+
<small>[Compare with 1.2.1](https://github.com/pawamoy/mkdocs-spellcheck/compare/1.2.1...1.2.2)</small>
|
|
11
|
+
|
|
12
|
+
### Build
|
|
13
|
+
|
|
14
|
+
- Drop support for Python 3.10 ([6f04fb6](https://github.com/pawamoy/mkdocs-spellcheck/commit/6f04fb6edf6e8b6d7c8f96e573789e6096040d9c) by Timothée Mazzucotelli).
|
|
15
|
+
|
|
8
16
|
## [1.2.1](https://github.com/pawamoy/mkdocs-spellcheck/releases/tag/1.2.1) - 2026-02-11
|
|
9
17
|
|
|
10
18
|
<small>[Compare with 1.2.0](https://github.com/pawamoy/mkdocs-spellcheck/compare/1.2.0...1.2.1)</small>
|
|
@@ -1,36 +1,26 @@
|
|
|
1
1
|
# Contributing
|
|
2
2
|
|
|
3
|
-
Contributions are welcome, and they are greatly appreciated
|
|
3
|
+
Contributions are welcome, and they are greatly appreciated. Every little bit helps, and credit will always be given.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**Please always create an issue before working on a new feature or a bug fix, so that we can discuss the implementation and make sure that your work will be merged.**
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## Environment setup
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Install [uv](https://github.com/astral-sh/uv) and [direnv](https://direnv.net/), fork and clone the repository, then:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
cd mkdocs-spellcheck
|
|
13
|
+
direnv allow
|
|
13
14
|
make setup
|
|
14
15
|
```
|
|
15
16
|
|
|
16
|
-
> NOTE: If it fails for some reason, you'll need to install [uv](https://github.com/astral-sh/uv) manually.
|
|
17
|
-
>
|
|
18
|
-
> You can install it with:
|
|
19
|
-
>
|
|
20
|
-
> ```bash
|
|
21
|
-
> curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
22
|
-
> ```
|
|
23
|
-
>
|
|
24
|
-
> Now you can try running `make setup` again, or simply `uv sync`.
|
|
25
|
-
|
|
26
17
|
You now have the dependencies installed.
|
|
27
18
|
|
|
28
19
|
Run `make help` to see all the available actions!
|
|
29
20
|
|
|
30
21
|
## Tasks
|
|
31
22
|
|
|
32
|
-
The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed,
|
|
33
|
-
while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
|
|
23
|
+
The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed, while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
|
|
34
24
|
|
|
35
25
|
If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project.
|
|
36
26
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
ISC License
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2022, Timothée Mazzucotelli
|
|
3
|
+
Copyright (c) 2022, Timothée Mazzucotelli and contributors
|
|
4
4
|
|
|
5
5
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
6
6
|
purpose with or without fee is hereby granted, provided that the above
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mkdocs-spellcheck
|
|
3
|
-
Version: 1.2.
|
|
3
|
+
Version: 1.2.2
|
|
4
4
|
Summary: A spell checker plugin for MkDocs.
|
|
5
|
-
Author-Email:
|
|
5
|
+
Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
|
|
6
6
|
License-Expression: ISC
|
|
7
7
|
License-File: LICENSE
|
|
8
8
|
Classifier: Development Status :: 4 - Beta
|
|
@@ -10,11 +10,11 @@ Classifier: Intended Audience :: Developers
|
|
|
10
10
|
Classifier: Programming Language :: Python
|
|
11
11
|
Classifier: Programming Language :: Python :: 3
|
|
12
12
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
14
13
|
Classifier: Programming Language :: Python :: 3.11
|
|
15
14
|
Classifier: Programming Language :: Python :: 3.12
|
|
16
15
|
Classifier: Programming Language :: Python :: 3.13
|
|
17
16
|
Classifier: Programming Language :: Python :: 3.14
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
18
18
|
Classifier: Topic :: Documentation
|
|
19
19
|
Classifier: Topic :: Software Development
|
|
20
20
|
Classifier: Topic :: Software Development :: Documentation
|
|
@@ -28,7 +28,7 @@ Project-URL: Issues, https://github.com/pawamoy/mkdocs-spellcheck/issues
|
|
|
28
28
|
Project-URL: Discussions, https://github.com/pawamoy/mkdocs-spellcheck/discussions
|
|
29
29
|
Project-URL: Gitter, https://gitter.im/mkdocs-spellcheck/community
|
|
30
30
|
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
31
|
-
Requires-Python: >=3.
|
|
31
|
+
Requires-Python: >=3.11
|
|
32
32
|
Requires-Dist: mkdocs>=1.5
|
|
33
33
|
Provides-Extra: all
|
|
34
34
|
Requires-Dist: mkdocs-spellcheck[codespell,symspellpy]; extra == "all"
|
|
@@ -45,7 +45,7 @@ Description-Content-Type: text/markdown
|
|
|
45
45
|
> This project is in maintenance mode. I'm now dedicating my time to [Zensical](https://zensical.org/). Feel free to reach out for a responsible transfer of maintainership.
|
|
46
46
|
|
|
47
47
|
[](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)
|
|
48
|
-
[](https://pawamoy.github.io/mkdocs-spellcheck/)
|
|
49
49
|
[](https://pypi.org/project/mkdocs-spellcheck/)
|
|
50
50
|
[](https://app.gitter.im/#/room/#mkdocs-spellcheck:gitter.im)
|
|
51
51
|
|
|
@@ -168,7 +168,7 @@ Here spelling checks are performed again.
|
|
|
168
168
|
<a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
169
169
|
<a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
170
170
|
<a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
171
|
-
<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=
|
|
171
|
+
<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=fe0e7bf2882d1c9c901a341c2502e1518466527a&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
172
172
|
<a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
173
173
|
<a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
174
174
|
<a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
@@ -180,18 +180,15 @@ Here spelling checks are performed again.
|
|
|
180
180
|
<a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
181
181
|
<a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
182
182
|
<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
183
|
-
<a href="https://github.com/blaisep"><img alt="blaisep" src="https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
184
183
|
<a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
185
184
|
<a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
186
185
|
<a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
187
186
|
<a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
188
187
|
<a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
189
|
-
<a href="https://github.com/Alphadelta14"><img alt="Alphadelta14" src="https://avatars.githubusercontent.com/u/480845?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
190
188
|
<a href="https://github.com/Cusp-AI"><img alt="Cusp-AI" src="https://avatars.githubusercontent.com/u/178170649?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
191
189
|
</p></div>
|
|
192
190
|
|
|
193
191
|
|
|
194
|
-
*And
|
|
192
|
+
*And 4 more private sponsor(s).*
|
|
195
193
|
|
|
196
194
|
<!-- sponsors-end -->
|
|
197
|
-
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
> This project is in maintenance mode. I'm now dedicating my time to [Zensical](https://zensical.org/). Feel free to reach out for a responsible transfer of maintainership.
|
|
5
5
|
|
|
6
6
|
[](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)
|
|
7
|
-
[](https://pawamoy.github.io/mkdocs-spellcheck/)
|
|
8
8
|
[](https://pypi.org/project/mkdocs-spellcheck/)
|
|
9
9
|
[](https://app.gitter.im/#/room/#mkdocs-spellcheck:gitter.im)
|
|
10
10
|
|
|
@@ -127,7 +127,7 @@ Here spelling checks are performed again.
|
|
|
127
127
|
<a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
128
128
|
<a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
129
129
|
<a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
130
|
-
<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=
|
|
130
|
+
<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=fe0e7bf2882d1c9c901a341c2502e1518466527a&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
131
131
|
<a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
132
132
|
<a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
133
133
|
<a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
@@ -139,18 +139,15 @@ Here spelling checks are performed again.
|
|
|
139
139
|
<a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
140
140
|
<a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
141
141
|
<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
142
|
-
<a href="https://github.com/blaisep"><img alt="blaisep" src="https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
143
142
|
<a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
144
143
|
<a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
145
144
|
<a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
146
145
|
<a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
147
146
|
<a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
148
|
-
<a href="https://github.com/Alphadelta14"><img alt="Alphadelta14" src="https://avatars.githubusercontent.com/u/480845?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
149
147
|
<a href="https://github.com/Cusp-AI"><img alt="Cusp-AI" src="https://avatars.githubusercontent.com/u/178170649?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
150
148
|
</p></div>
|
|
151
149
|
|
|
152
150
|
|
|
153
|
-
*And
|
|
151
|
+
*And 4 more private sponsor(s).*
|
|
154
152
|
|
|
155
153
|
<!-- sponsors-end -->
|
|
156
|
-
|
|
@@ -1,34 +1,14 @@
|
|
|
1
|
-
target-version = "
|
|
1
|
+
target-version = "py311"
|
|
2
2
|
line-length = 120
|
|
3
|
+
output-format = "concise"
|
|
3
4
|
|
|
4
5
|
[lint]
|
|
5
6
|
exclude = [
|
|
6
7
|
"tests/fixtures/*.py",
|
|
7
8
|
]
|
|
8
|
-
select = [
|
|
9
|
-
"A", "ANN", "ARG",
|
|
10
|
-
"B", "BLE",
|
|
11
|
-
"C", "C4",
|
|
12
|
-
"COM",
|
|
13
|
-
"D", "DTZ",
|
|
14
|
-
"E", "ERA", "EXE",
|
|
15
|
-
"F", "FBT",
|
|
16
|
-
"G",
|
|
17
|
-
"I", "ICN", "INP", "ISC",
|
|
18
|
-
"N",
|
|
19
|
-
"PGH", "PIE", "PL", "PLC", "PLE", "PLR", "PLW", "PT", "PYI",
|
|
20
|
-
"Q",
|
|
21
|
-
"RUF", "RSE", "RET",
|
|
22
|
-
"S", "SIM", "SLF",
|
|
23
|
-
"T", "T10", "T20", "TCH", "TID", "TRY",
|
|
24
|
-
"UP",
|
|
25
|
-
"W",
|
|
26
|
-
"YTT",
|
|
27
|
-
]
|
|
9
|
+
select = ["ALL"]
|
|
28
10
|
ignore = [
|
|
29
11
|
"A001", # Variable is shadowing a Python builtin
|
|
30
|
-
"ANN101", # Missing type annotation for self
|
|
31
|
-
"ANN102", # Missing type annotation for cls
|
|
32
12
|
"ANN204", # Missing return type annotation for special method __str__
|
|
33
13
|
"ANN401", # Dynamically typed expressions (typing.Any) are disallowed
|
|
34
14
|
"ARG005", # Unused lambda argument
|
|
@@ -36,13 +16,18 @@ ignore = [
|
|
|
36
16
|
"D105", # Missing docstring in magic method
|
|
37
17
|
"D417", # Missing argument description in the docstring
|
|
38
18
|
"E501", # Line too long
|
|
19
|
+
"EM101", # String literal when raising exception
|
|
20
|
+
"EM102", # f-string when raising exception
|
|
39
21
|
"ERA001", # Commented out code
|
|
22
|
+
"FIX", # TODO, FIXME, etc.
|
|
40
23
|
"G004", # Logging statement uses f-string
|
|
41
24
|
"PLR0911", # Too many return statements
|
|
42
25
|
"PLR0912", # Too many branches
|
|
43
26
|
"PLR0913", # Too many arguments to function call
|
|
44
27
|
"PLR0915", # Too many statements
|
|
45
28
|
"SLF001", # Private member accessed
|
|
29
|
+
"TD002", # Missing author in TODO
|
|
30
|
+
"TD003", # Missing issue link for TODO
|
|
46
31
|
"TRY003", # Avoid specifying long messages outside the exception class
|
|
47
32
|
]
|
|
48
33
|
|
|
@@ -4,9 +4,6 @@
|
|
|
4
4
|
"**/.venvs*/**": true,
|
|
5
5
|
"**/venv*/**": true
|
|
6
6
|
},
|
|
7
|
-
"mypy-type-checker.args": [
|
|
8
|
-
"--config-file=config/mypy.ini"
|
|
9
|
-
],
|
|
10
7
|
"python.testing.unittestEnabled": false,
|
|
11
8
|
"python.testing.pytestEnabled": true,
|
|
12
9
|
"python.testing.pytestArgs": [
|
|
@@ -19,6 +16,7 @@
|
|
|
19
16
|
"ruff.lint.args": [
|
|
20
17
|
"--config=config/ruff.toml"
|
|
21
18
|
],
|
|
19
|
+
"ty.configurationFile": "config/ty.toml",
|
|
22
20
|
"yaml.schemas": {
|
|
23
21
|
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
|
|
24
22
|
},
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
// Project-local debug tasks
|
|
2
|
+
//
|
|
3
|
+
// For more documentation on how to configure debug tasks,
|
|
4
|
+
// see: https://zed.dev/docs/debugger
|
|
5
|
+
[
|
|
6
|
+
{
|
|
7
|
+
"label": "python (current file)",
|
|
8
|
+
"adapter": "Debugpy",
|
|
9
|
+
"request": "launch",
|
|
10
|
+
"program": "$ZED_FILE",
|
|
11
|
+
"justMyCode": false
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"label": "run",
|
|
15
|
+
"adapter": "Debugpy",
|
|
16
|
+
"request": "launch",
|
|
17
|
+
"module": "mkdocs_spellcheck",
|
|
18
|
+
"justMyCode": false
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"label": "docs",
|
|
22
|
+
"adapter": "Debugpy",
|
|
23
|
+
"request": "launch",
|
|
24
|
+
"module": "zensical",
|
|
25
|
+
"args": [
|
|
26
|
+
"serve"
|
|
27
|
+
],
|
|
28
|
+
"justMyCode": false
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"label": "test",
|
|
32
|
+
"adapter": "Debugpy",
|
|
33
|
+
"request": "launch",
|
|
34
|
+
"module": "pytest",
|
|
35
|
+
"args": [
|
|
36
|
+
"-c=config/pytest.ini",
|
|
37
|
+
"-vvv",
|
|
38
|
+
"--no-cov",
|
|
39
|
+
"--dist=no",
|
|
40
|
+
"tests"
|
|
41
|
+
],
|
|
42
|
+
"justMyCode": false
|
|
43
|
+
}
|
|
44
|
+
]
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
// Zed settings
|
|
2
|
+
//
|
|
3
|
+
// For information on how to configure Zed, see the Zed
|
|
4
|
+
// documentation: https://zed.dev/docs/configuring-zed
|
|
5
|
+
//
|
|
6
|
+
// To see all of Zed's default settings without changing your
|
|
7
|
+
// custom settings, run `zed: open default settings` from the
|
|
8
|
+
// command palette (cmd-shift-p / ctrl-shift-p)
|
|
9
|
+
{
|
|
10
|
+
"languages": {
|
|
11
|
+
"YAML": {
|
|
12
|
+
"auto_indent_on_paste": false,
|
|
13
|
+
"auto_indent": "preserve_indent",
|
|
14
|
+
"format_on_save": "off"
|
|
15
|
+
},
|
|
16
|
+
"Python": {
|
|
17
|
+
"language_servers": ["ty", "ruff"],
|
|
18
|
+
"code_actions_on_format": {
|
|
19
|
+
"source.organizeImports.ruff": true
|
|
20
|
+
},
|
|
21
|
+
"formatter": {
|
|
22
|
+
"language_server": {
|
|
23
|
+
"name": "ruff"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"lsp": {
|
|
29
|
+
"ty": {
|
|
30
|
+
"settings": {
|
|
31
|
+
"configurationFile": "config/ty.toml"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"ruff": {
|
|
35
|
+
"initialization_options": {
|
|
36
|
+
"settings": {
|
|
37
|
+
"configurationPreference": "filesystemFirst",
|
|
38
|
+
"configuration": "config/ruff.toml"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"label": "changelog",
|
|
4
|
+
"command": "scripts/make",
|
|
5
|
+
"args": ["changelog"]
|
|
6
|
+
},
|
|
7
|
+
{
|
|
8
|
+
"label": "check",
|
|
9
|
+
"command": "scripts/make",
|
|
10
|
+
"args": ["check"]
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"label": "check-quality",
|
|
14
|
+
"command": "scripts/make",
|
|
15
|
+
"args": ["check-quality"]
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"label": "check-types",
|
|
19
|
+
"command": "scripts/make",
|
|
20
|
+
"args": ["check-types"]
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"label": "check-docs",
|
|
24
|
+
"command": "scripts/make",
|
|
25
|
+
"args": ["check-docs"]
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"label": "check-api",
|
|
29
|
+
"command": "scripts/make",
|
|
30
|
+
"args": ["check-api"]
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"label": "clean",
|
|
34
|
+
"command": "scripts/make",
|
|
35
|
+
"args": ["clean"]
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"label": "docs",
|
|
39
|
+
"command": "scripts/make",
|
|
40
|
+
"args": ["docs"]
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"label": "docs-deploy",
|
|
44
|
+
"command": "scripts/make",
|
|
45
|
+
"args": ["docs-deploy"]
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"label": "format",
|
|
49
|
+
"command": "scripts/make",
|
|
50
|
+
"args": ["format"]
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"label": "release",
|
|
54
|
+
"command": "scripts/make",
|
|
55
|
+
"args": ["release"]
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"label": "setup",
|
|
59
|
+
"command": "scripts/make",
|
|
60
|
+
"args": ["setup"]
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"label": "test",
|
|
64
|
+
"command": "scripts/make",
|
|
65
|
+
"args": ["test", "coverage"]
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"label": "vscode",
|
|
69
|
+
"command": "scripts/make",
|
|
70
|
+
"args": ["vscode"]
|
|
71
|
+
}
|
|
72
|
+
]
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!-- Giscus -->
|
|
2
|
-
<!-- https://
|
|
2
|
+
<!-- https://zensical.org/docs/setup/comment-system/#giscus-integration -->
|
|
3
3
|
<div id="feedback" style="display: none;">
|
|
4
4
|
<h2 id="__comments">Feedback</h2>
|
|
5
5
|
<script src="https://giscus.app/client.js"
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/* Mark external links as such. */
|
|
2
|
+
a.external::after,
|
|
3
|
+
a.autorefs-external::after {
|
|
4
|
+
/* https://primer.style/octicons/arrow-up-right-24 */
|
|
5
|
+
mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
|
|
6
|
+
-webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
|
|
7
|
+
content: ' ';
|
|
8
|
+
|
|
9
|
+
display: inline-block;
|
|
10
|
+
vertical-align: middle;
|
|
11
|
+
position: relative;
|
|
12
|
+
|
|
13
|
+
height: 1em;
|
|
14
|
+
width: 1em;
|
|
15
|
+
background-color: currentColor;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
a.external:hover::after,
|
|
19
|
+
a.autorefs-external:hover::after {
|
|
20
|
+
background-color: var(--md-accent-fg-color);
|
|
21
|
+
}
|