doc-cov
doc-cov is a tool for measuring docstring coverage of Python project.
- Python versions >= 3.6
Quick start
- Install doc-cov from pip.
- Use
doccov PROJECT_PATH
$ doccov tests/sample_project
function 3 / 5 60.00%
Options
Target object
doc-cov can measure docstring coverage of functions, classes and modules.
functions (default, -f)
$ doccov tests/sample_project -f
function 3 / 5 60.00%
classes -c
$ doccov tests/sample_project -c
class 2 / 2 100.00%
modules -m
$ doccov tests/sample_project -m
module 3 / 7 42.86%
Output
str (default, --output str)
$ doccov tests/sample_project -fmc --output str
class 2 / 2 100.00%
module 3 / 7 42.86%
function 3 / 5 60.00%
csv --output csv
$ doccov tests/sample_project -fmc --output csv
coverage,class,2,2,100.00%
coverage,module,3,7,42.86%
coverage,function,3,5,60.00%
Target
Print coverage of whole (default)
$ doccov tests/sample_project
function 3 / 5 60.00%
Print all coverage of modules --all
$ doccov tests/sample_project --all
=============================
module_fulldoc
-----------------------------
function 1 / 1 100.00%
=============================
package_A
-----------------------------
function 0 / 0 -
=============================
package_A.module_fulldoc
-----------------------------
function 1 / 1 100.00%
=============================
package_B
-----------------------------
function 0 / 0 -
=============================
package_B.module_shortdoc
-----------------------------
function 1 / 1 100.00%
=============================
package_B.package_B_1
-----------------------------
function 0 / 0 -
=============================
package_B.package_B_1.module_nodoc
-----------------------------
function 0 / 2 0.00%
=============================
coverage
-----------------------------
function 3 / 5 60.00%
1 maintainer
Metadata
1 maintainer
Release files for doc-cov 0.2.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 | |
|---|---|---|---|---|
| doc-cov-0.2.0.tar.gz | 4.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| doc_cov-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.4 kB
Release files / doc-cov-0.2.0.tar.gz
| Download URL | doc-cov-0.2.0.tar.gz |
|---|---|
| Size | 4.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fcda7a2cbec807e5b2e46ed61db93c089847645b2e36db952167925b6f918083
|
|
BLAKE2b-256 checksum How to use checksums |
3e96b11a253af91d70ebccf4a26f13c2398530c62981ec0126ea4b46a2072531
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.6
|
Release files / doc_cov-0.2.0-py3-none-any.whl
| Download URL | doc_cov-0.2.0-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ad8e8a38c0990028e74f6414ffe6086672f045019bdbc38a8eb0a35bb8d0fa8c
|
|
BLAKE2b-256 checksum How to use checksums |
816dace32d150f94b13cb160b922dd146cda4266c8241091c738f022c2e92aee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.6
|
Security for doc-cov 0.2.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.
