https://github.com/reity/richreports-py
Library that supports the construction of human-readable, interactive static analysis reports that consist of decorated concrete syntax representations of programs.
https://github.com/reity/richreports-py
Last synced: 2 months ago
JSON representation
Library that supports the construction of human-readable, interactive static analysis reports that consist of decorated concrete syntax representations of programs.
- Host: GitHub
- URL: https://github.com/reity/richreports-py
- Owner: reity
- License: mit
- Created: 2024-03-22T04:56:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T18:10:14.000Z (about 1 year ago)
- Last Synced: 2025-02-23T18:48:09.332Z (3 months ago)
- Language: Python
- Homepage: https://richreports.readthedocs.io
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
===========
richreports
===========
Library that supports the construction of human-readable, interactive static analysis reports that consist of decorated concrete syntax representations of programs.
|pypi| |readthedocs| |actions| |coveralls|
.. |pypi| image:: https://badge.fury.io/py/richreports.svg#
:target: https://badge.fury.io/py/richreports
:alt: PyPI version and link.
.. |readthedocs| image:: https://readthedocs.org/projects/richreports/badge/?version=latest
:target: https://richreports.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.
.. |actions| image:: https://github.com/reity/richreports-py/workflows/lint-test-cover-docs/badge.svg#
:target: https://github.com/reity/richreports-py/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.
.. |coveralls| image:: https://coveralls.io/repos/github/reity/richreports-py/badge.svg?branch=main
:target: https://coveralls.io/github/reity/richreports-py?branch=main
:alt: Coveralls test coverage summary.
Installation and Usage
----------------------
This library is available as a `package on PyPI `__:
.. code-block:: bash
python -m pip install richreports
The library can be imported in the usual way:
.. code-block:: python
from richreports import *
Examples
^^^^^^^^
.. |report| replace:: ``report``
.. _report: https://richreports.readthedocs.io/en/0.2.0/_source/richreports.html#richreports.richreports.report
This library supports the enrichment of concrete syntax strings with delimiters. A |report|_ instance can be created from a concrete string and then enriched:
.. code-block:: python
>>> r = report(
... 'def f(x, y):\n' +
... ' return x + y'
... )
>>> r.enrich((2, 11), (2, 15), '(', ')')
>>> for line in r.render().split('\n'):
... print(line)
def f(x, y):
return (x + y)
This makes it possible to succinctly build up reports that correspond to structured representation formats such as HTML:
.. code-block:: python
>>> r.enrich((1, 0), (2, 15), '', '', True)
>>> for line in r.render().split('\n'):
... print(line)
def f(x, y):
return (x + y)
>>> r.enrich((1, 0), (2, 15), '
\n', '\n')
>>> for line in r.render().split('\n'):
... print(line)
def f(x, y):
return (x + y)
Development
-----------
All installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements `__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip `__:
.. code-block:: bash
python -m pip install .[docs,lint]
Documentation
^^^^^^^^^^^^^
The documentation can be generated automatically from the source files using `Sphinx `__:
.. code-block:: bash
python -m pip install .[docs]
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html
Testing and Conventions
^^^^^^^^^^^^^^^^^^^^^^^
All unit tests are executed and their coverage is measured when using `pytest `__ (see the ``pyproject.toml`` file for configuration details):
.. code-block:: bash
python -m pip install .[test]
python -m pytest
Alternatively, all unit tests are included in the module itself and can be executed using `doctest `__:
.. code-block:: bash
python src/richreports/richreports.py -v
Style conventions are enforced using `Pylint `__:
.. code-block:: bash
python -m pip install .[lint]
python -m pylint src/richreports
Contributions
^^^^^^^^^^^^^
In order to contribute to the source code, open an issue or submit a pull request on the `GitHub page `__ for this library.
Versioning
^^^^^^^^^^
Beginning with version 0.1.0, the version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 `__.
Publishing
^^^^^^^^^^
This library can be published as a `package on PyPI `__ by a package maintainer. First, install the dependencies required for packaging and publishing:
.. code-block:: bash
python -m pip install .[publish]
Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule `__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number):
.. code-block:: bash
git tag ?.?.?
git push origin ?.?.?
Remove any old build/distribution files. Then, package the source into a distribution archive:
.. code-block:: bash
rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .
Finally, upload the package distribution archive to `PyPI `__:
.. code-block:: bash
python -m twine upload dist/*