Metadata-Version: 2.1
Name: puncover-riscv
Version: 0.2.3
Summary: Analyses RISCV C/C++ build output for code size, static variables, and stack usage.
Home-page: https://github.com/Egahp/puncover_riscv
Author: Egahp
License: MIT
Download-URL: https://github.com/Egahp/puncover_riscv/tarball/0.2.3
Description: 
        .. image:: https://img.shields.io/badge/GitHub-Egahp/puncover_riscv-8da0cb?style=flat-square&logo=github
           :alt: GitHub Link
           :target: https://github.com/Egahp/puncover_riscv
        
        .. image:: https://img.shields.io/github/workflow/status/Egahp/puncover_riscv/Python%20package/master?style=flat-square
           :alt: GitHub Workflow Status (branch)
           :target: https://github.com/Egahp/puncover_riscv/actions?query=branch%3Amaster+
        
        .. image:: https://img.shields.io/codecov/c/github/Egahp/puncover_riscv/master?style=flat-square
           :alt: Codecov branch
           :target: https://codecov.io/gh/Egahp/puncover_riscv
        
        .. image:: https://img.shields.io/pypi/v/puncover_riscv?style=flat-square
           :alt: PyPI
           :target: https://pypi.org/project/puncover_riscv
        
        .. image:: https://img.shields.io/pypi/pyversions/puncover_riscv?style=flat-square
           :alt: PyPI - Python Version
           :target: https://pypi.org/project/puncover_riscv
        
        .. image:: https://img.shields.io/github/license/Egahp/puncover?color=blue&style=flat-square
           :alt: License - MIT
           :target: https://github.com/Egahp/puncover_riscv
        
        puncover
        ========
        
        .. image:: https://raw.githubusercontent.com/Egahp/puncover_riscv/master/images/overview.png
        
        Analyzes RISCV 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.This project based on https://github.com/HBehrens/puncover, but only support arch riscv.
        Add -fstask-usage to your gcc build flag. By Heiko Behrens - MIT license, copyright © 2014-2017
        
        Installation and Usage
        ======================
        
        Install with pip:
        
        .. code-block:: bash
        
           pip install puncover_riscv
        
        Run it by passing the binary to analyze:
        
        .. code-block:: bash
        
           puncover_riscv --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
        
           ..  code-block:: bash
        
                 curl https://pyenv.run | bash
        
        2. install all the python environments, using this bashism (this can take a few
           minutes):
        
           ..  code-block:: bash
        
                 for _py in $(<.python-version ); do pyenv install ${_py}; done
        
        3. install the development dependencies:
        
           ..  code-block:: bash
        
              pip install -r requirements-dev.txt
        
        
        Then you can run the tests with:
        
        ..  code-block:: bash
        
           tox
        
        Publishing Release
        ==================
        
        1. Update the version in ``puncover_riscv/__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/Egahp/puncover_riscv/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.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
