Skip to main content

PyBuilder plugin that checks documentation coverage using docstr-coverage

Project description

Uses docstr-coverage to check documentation coverage of your project.

You can configure the docstr-coverage package using the following properties:

  • docstr_coverage_fail_under: The minimum coverage percentage that must be achieved. If the coverage is below this value, the build will fail. This will take precedence over the value set in the configuration file.

  • docstr_coverage_config: The path to the configuration file for docstr-coverage. Default: .docstr.yaml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybuilder-docstr-coverage-0.1.0.tar.gz (2.2 kB view details)

Uploaded Source

Built Distributions

pybuilder_docstr_coverage-0.1.0-py3.10.egg (3.0 kB view details)

Uploaded Source

File details

Details for the file pybuilder-docstr-coverage-0.1.0.tar.gz.

File metadata

File hashes

Hashes for pybuilder-docstr-coverage-0.1.0.tar.gz
Algorithm Hash digest
SHA256 35833145e6ffb907691e0f42b1d162290198608e2939ff3c9d40525a33c9380b
MD5 5b184fe39c0ee48f6838614252534529
BLAKE2b-256 4435ec8e56439a14d3f3a639bba1581813a4027e8bc3704d05728565ba7cd4d7

See more details on using hashes here.

File details

Details for the file pybuilder_docstr_coverage-0.1.0-py3.10.egg.

File metadata

File hashes

Hashes for pybuilder_docstr_coverage-0.1.0-py3.10.egg
Algorithm Hash digest
SHA256 43c802e0bed548054dc68ff137bbacc037da47785223af48b8dd91ca2e164bc1
MD5 cedb6d92e3ce9ac43d0c202b60a19428
BLAKE2b-256 ad8c9a7f47a878ecd0b82f768c2ab62e2c84c55660a3432e88e7045a7469fa58

See more details on using hashes here.

File details

Details for the file pybuilder_docstr_coverage-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pybuilder_docstr_coverage-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f1f32f479fe5dd29f259e929eb86568501a445a33ef3923a9f80365eed3ce10
MD5 6a1728a8c306735f24d3504487226cde
BLAKE2b-256 9c193bfb077db49fb72bad9018de3b916fa0509b0088bd17fd56fc4f4c0c2f4c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page