Skip to content

Silicon Heaven Tree definition and Python library to work with it.

License

Notifications You must be signed in to change notification settings

silicon-heaven/shvtree

Repository files navigation

Silicon Heaven Tree

SHVTree logo [*]_

This provides common parser and validator for Silicon Heaven tree representation. It is formed of nodes forming path and methods associated with those paths as defined in Silicon Heaven RPC.

The SHV Tree simplifies and implements common operations such as ls and dir methods and basic type description. The core of this project is definition of format describing the tree but it also provides SHV device implementation based on the provided tree.

Installation

The installation can be done with package manager pip.

$ pip install pyshvtree

Running tests

This project contains basic tests in directory tests; see the dependencies in the pyproject.toml file.

To run tests you have to use pytest. To run all tests just run it in the top level directory of the project:

pytest

See the pytest documentation for more info.

Documentation

The documentation is available in docs directory. You can build it using:

sphinx-build -b html docs docs-html
[*]Project logo is assembled from images by Freepik