nile-coverage
Nile plugin adding coverage reports for Cairo Smart Contracts.
Getting started
Install the plugin inside the virtual environment of your Nile project:
(env): pip install nile-coverage
Nile automatically detects installed plugins using python entry points feature. You should see the coverage command listed running nile, and you can run the report with:
(env): nile coverage
For a full list of options run:
(env): nile coverage --help
Recipes
1. Run coverage in a subset of the tests suite.
Mark tests with pytest marks and use the --mark argument to run a subset of tests:
(env): nile coverage -m unit
2. Integrate with codecov.io.
Generate a cobertura format coverage xml file named "coverage.xml" using the --xml flag:
(env): nile coverage --xml
3. Change the default folder containing Smart Contracts.
If your Smart Contracts are in a different folder than "contracts" (Nile default), use the
--contracts-folder flag to set the correct one:
(env): nile coverage -c src
Acknowledgements
This package uses the starknet-edu/cairo-coverage Virtual Machine override to get covered lines for the final report. Special thanks to @LucasLvy from StarkWare!
Metadata
Release files for nile-coverage 0.2.5.1
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 |
|---|---|---|---|---|
| nile-coverage-0.2.5.1.tar.gz | 17.2 kB | Without provenance | Details for nile-coverage-0.2.5.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nile_coverage-0.2.5.1-py3-none-any.whl | Python 3 | none | any | Details for nile_coverage-0.2.5.1-py3-none-any.whl |
Total release size: 31.8 kB
Release files / nile-coverage-0.2.5.1.tar.gz
| Download URL | nile-coverage-0.2.5.1.tar.gz |
|---|---|
| Size | 17.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
32e816805efb54f21964af1ad019d2aabe54ea7401dd191de6bf1132ce193ab3
|
|
BLAKE2b-256 checksum How to use checksums |
ed892a7b88761be25fd7267acb5f2dcfa0bfe74817ef787e23e59b6f769915f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.9
|
Release files / nile_coverage-0.2.5.1-py3-none-any.whl
| Download URL | nile_coverage-0.2.5.1-py3-none-any.whl |
|---|---|
| Size | 14.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f1bec4da90418087d609bc3a8d0c81f5f16e31e0c6e22c5c2b3c1020b088cd0e
|
|
BLAKE2b-256 checksum How to use checksums |
8ded8d3acc3f3c3883d14d133d16705bf95aa4df35f754dde68e423369aa03ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.9
|
Security for nile-coverage 0.2.5.1
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.