Skip to main content

Analyses C/C++ build output for code size, static variables, and stack usage.

Reason this release was yanked:

Bug in this release, tool will not start. Fixed in 0.3.1

Project description

GitHub Link GitHub Workflow Status (branch) Codecov branch PyPI PyPI - Python Version License - MIT

puncover

https://raw.githubusercontent.com/HBehrens/puncover/master/images/overview.png

Analyzes C/C++ binaries for code size, static variables and stack usages. It creates a report with disassembler and call-stack analysis per directory, file, or function.

Installation and Usage

Install with pip:

pip install puncover

Run it by passing the binary to analyze:

puncover --elf_file project.elf
...
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Open the link in your browser to view the analysis.

Running Tests Locally

To run the tests locally, you need to install the development dependencies:

  1. install pyenv: https://github.com/pyenv/pyenv

    curl https://pyenv.run | bash
  2. install all the python environments, using this bashism (this can take a few minutes):

    for _py in $(<.python-version ); do pyenv install ${_py}; done
  3. install the development dependencies:

    pip install -r requirements-dev.txt

Then you can run the tests with:

tox

Publishing Release

  1. Update the version in puncover/__version__.py.

  2. Commit the version update: .. code-block:: bash

    git add . && git commit -m “Bump version to x.y.z”

  3. Create an annotated tag: .. code-block:: bash

    git tag -a {-m=,}x.y.z

  4. Push the commit and tag: .. code-block:: bash

    git push && git push –tags

  5. Either wait for the GitHub Action to complete and download the release artifact for uploading: https://github.com/HBehrens/puncover/actions OR Build the package locally: python setup.py sdist bdist_wheel

  6. Upload the package to PyPI: .. code-block:: bash

    twine upload dist/*

  7. Create GitHub releases: - gh release create --generate-notes x.y.z - attach the artifacts to the release too: gh release upload x.y.z dist/*

Release Script

See scripts/release.sh for a script that automates the above steps.

Contributing

Contributions are welcome! Please open an issue or pull request on GitHub.

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

puncover-0.3.0.tar.gz (171.4 kB view details)

Uploaded Source

Built Distribution

puncover-0.3.0-py3-none-any.whl (170.7 kB view details)

Uploaded Python 3

File details

Details for the file puncover-0.3.0.tar.gz.

File metadata

  • Download URL: puncover-0.3.0.tar.gz
  • Upload date:
  • Size: 171.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for puncover-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f5878302ec945ed45182827c58c67221b93c379fa1c99846e5f16e88ba7c0db5
MD5 2a672b7932272f61a68e92abe9a4f68c
BLAKE2b-256 2fd3637b2c8b9838bff924469b211064fa5a56c29f155dee5903c079d4a40478

See more details on using hashes here.

File details

Details for the file puncover-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: puncover-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 170.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for puncover-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f460a966fb40a235c6090db77b06f9f3d26abed91d959f17e13b8ae07f8e567
MD5 a9bb666c8ae3fc75925b392a4445b3e2
BLAKE2b-256 f107879235e0b45c0424abea594bde944c1dd4815feeb9fc68b467dab40afc52

See more details on using hashes here.

Supported by

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