Skip to main content
[![Build Status](https://travis-ci.org/sanbales/ipython-coverage.svg?branch=master)](https://travis-ci.org/sanbales/ipython-coverage)

# IPython Coverage
Introduces `%coverage` and `%%coverage` magics to allow running
of [coverage](https://github.com/nedbat/coveragepy)
from a [Jupyter Notebook](https://github.com/jupyter/notebook).

It currently presents the coverage HTML report as an IFrame.

# Installation
```bash
pip install ipycoverage
```

# Usage

## Load the extension
```ipython
%load_ext ipycov
```

## Use the magic
In a cell, you can run the cell magic like such:
```ipython
%%coverage
from your_module import your_function # or anything else you want to import

your_function()
```

twine register dist/pad-on-left-1.0.0.tar.gz -r testpypi

Or simply run the line magic:
```ipython
%coverage function_to_call()
```

# Important Note
> This is not a fully developed magic, and it is not stable yet.
>
> It has only been tested against:
> * `coverage==4.5.2`
> * `IPython==7.0.1`.
> * `JupyterLab==0.35.1`

## Missing Features / Future Work
* Improve naming and instructions
* Add more options; potentially dynamically load them from `coverage`
* Add tests
* Add examples
* Add CI/CD
* Submit to PyPI and Conda

Metadata

Release files for ipycov 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ipycov 0.0.1
File Size Uploaded Provenance Actions
ipycov-0.0.1.tar.gz 3.6 kB Without provenance Details for ipycov-0.0.1.tar.gz

Release files / ipycov-0.0.1.tar.gz

Download URL ipycov-0.0.1.tar.gz
Size 3.6 kB
Tags Source
SHA-256 checksum
How to use checksums
fb2ee3c40e69dfcb4a440f7bbb4f529bd3fbdf3e34fdbc5f84d3aa737211856e
BLAKE2b-256 checksum
How to use checksums
507a2d4358579fd1b4997012f6c742d97cd358c7760b0aa36698a57adc5737df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

Security for ipycov 0.0.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.

Release history Release notifications | RSS feed

This release

0.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page