tesserakit-docs
Measure Python docstring coverage for public symbols.
tessera-docs parses Python source with the standard-library ast module (it never imports or runs the code), inventories every documentable symbol (modules, classes, functions, methods), and reports which public ones lack docstrings.
Coverage check
tessera docs coverage --input . --output ./out/docs_pack
tessera docs coverage --input . --include-tests # also scan test files
Test files are excluded by default; pass --include-tests to include them.
Artifacts written:
symbols.jsonl one DocSymbol per symbol (kind, public, has_docstring, line)
index.md coverage headline
validation_report.md missing-docstring findings + low-coverage warning
coverage_report.md coverage by kind and lowest-coverage files
undocumented.md every undocumented public symbol with file:line
What counts
- Public = name does not start with
_(so_privateand__dunder__are excluded). - Symbol kinds:
module,class,function,method. - A symbol is documented if
ast.get_docstringreturns a value.
Findings
missing_module_docstring(info)missing_class_docstring,missing_function_docstring,missing_method_docstring(warning)low_doc_coverage— overall public coverage below 80%parse_error— a file could not be parsedno_public_symbols— nothing public found
Metadata
Release files for tesserakit-docs 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tesserakit_docs-0.4.0.tar.gz | 6.6 kB | Without provenance | Details for tesserakit_docs-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tesserakit_docs-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for tesserakit_docs-0.4.0-py3-none-any.whl |
Total release size: 15.2 kB
Release files / tesserakit_docs-0.4.0.tar.gz
| Download URL | tesserakit_docs-0.4.0.tar.gz |
|---|---|
| Size | 6.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ab74b4c701afb2f07dc1c770b223f786f84eb3ce1053dd70a6e7d4acc0e00f0a
|
|
BLAKE2b-256 checksum How to use checksums |
2c881a4b20742625d104aa218aca688d40840b887c74041a25091db375990072
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
Release files / tesserakit_docs-0.4.0-py3-none-any.whl
| Download URL | tesserakit_docs-0.4.0-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f1fbf3a46bf2bb9725d4b65cf4c29cbf5d2d6ddcc6cba2159e0275c45f2dfda2
|
|
BLAKE2b-256 checksum How to use checksums |
0d505bd5632c63b8d5a451cfa793dfd9d21e2142c555ea2da5c4d9d78619e5c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
Security for tesserakit-docs 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.