Bucket
Bucket is a python library to create nicer functional coverpoints. There are several benefits writing the coverage in python, such as:
- Easier integration into cocotb and other python testbenches
- No commercial EDA license required
- Vendor independence - easily collect coverage from multiple tools/sources (eg. models, log parsers, etc)
Install
pip install noodle-bucket
This installs the Python library (import bucket) and the bucket CLI.
It is enough to write coverpoints, collect coverage, and export .bktgz /
SQL / JSON / console output. View results in the hosted viewer
or the desktop app.
Generating standalone HTML (bucket write html / bucket write report)
needs a source checkout of this repository and Node.js; it is not part of
the pip package.
Documentation
The user documentation lives in the docs/ directory and can be read directly on GitHub, starting from docs/index.md.
For a richer browsing experience, you can also run the MkDocs site locally:
./bin/shell
mkdocs serve
Then open http://127.0.0.1:8000/ in your browser.
Viewer
A copy of the viewer is hosted at: https://noodle-bytes.github.io/bucket/
Support
This library is being actively built, and is expected to change while it matures and key features are added. We are not providing external support for use of this library, however we are aiming to make it as easy to use as possible.
As per the licence:
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Contributions
We will be introducing a contributor licence agreement in the near future. In the meantime, if you want to contribute please get in touch.
Please feel free to contribute to the project, following these guidelines:
- Please contribute by creating a fork and submitting a pull request.
- Pull requests should be as small as possible to resolve the issue they are trying to address.
- Pull requests must respect the goals of the library, as stated in the documentation.
- Pull requests should take care not to make performance worse except for cases which require bug fixes.
- Pull requests should update the documentation for any added/changed functionality.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file noodle_bucket-2.7.4.tar.gz.
File metadata
- Download URL: noodle_bucket-2.7.4.tar.gz
- Upload date:
- Size: 36.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
525f3f70470faa21750c47c26d1e4d19a6f4466e4a83a04157e296f1d4b340f1
|
|
| MD5 |
c909a038d603f0e084591f47d7f285fb
|
|
| BLAKE2b-256 |
9981666458abbbb01342594285b3a4e2b9f61e966b6c06ff9156d76bbb817673
|
Provenance
The following attestation bundles were made for noodle_bucket-2.7.4.tar.gz:
Publisher:
publish-pypi.yml on Noodle-Bytes/bucket
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
noodle_bucket-2.7.4.tar.gz -
Subject digest:
525f3f70470faa21750c47c26d1e4d19a6f4466e4a83a04157e296f1d4b340f1 - Sigstore transparency entry: 2668655201
- Sigstore integration time:
-
Permalink:
Noodle-Bytes/bucket@3955048bf4e2f6d0f9495f3349aff4ea30c9c20c -
Branch / Tag:
refs/tags/v2.7.4 - Owner: https://github.com/Noodle-Bytes
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@3955048bf4e2f6d0f9495f3349aff4ea30c9c20c -
Trigger Event:
push
-
Statement type:
File details
Details for the file noodle_bucket-2.7.4-py3-none-any.whl.
File metadata
- Download URL: noodle_bucket-2.7.4-py3-none-any.whl
- Upload date:
- Size: 48.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73bf7a73cf309193cede1e79687f061ee8a65b0026a300de61a0c0406d2a2319
|
|
| MD5 |
cf1c981c9db82ff1b333a61027896a79
|
|
| BLAKE2b-256 |
5e8a60a86aefd1bb25014780530fbc829adf6a45b0f4776fac39dbda40b7c96b
|
Provenance
The following attestation bundles were made for noodle_bucket-2.7.4-py3-none-any.whl:
Publisher:
publish-pypi.yml on Noodle-Bytes/bucket
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
noodle_bucket-2.7.4-py3-none-any.whl -
Subject digest:
73bf7a73cf309193cede1e79687f061ee8a65b0026a300de61a0c0406d2a2319 - Sigstore transparency entry: 2668655232
- Sigstore integration time:
-
Permalink:
Noodle-Bytes/bucket@3955048bf4e2f6d0f9495f3349aff4ea30c9c20c -
Branch / Tag:
refs/tags/v2.7.4 - Owner: https://github.com/Noodle-Bytes
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@3955048bf4e2f6d0f9495f3349aff4ea30c9c20c -
Trigger Event:
push
-
Statement type:
