Metadata-Version: 2.1
Name: pyshv
Version: 0.3.0
Summary: Pure Python SHV implementation
Author: Elektroline a.s.
Project-URL: Homepage, https://gitlab.com/elektroline-predator/pyshv
Project-URL: Bug Tracker, https://gitlab.com/elektroline-predator/pyshv/-/issues
Project-URL: Github, https://github.com/silicon-heaven/libshv-py
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
Provides-Extra: docs
Provides-Extra: test
Provides-Extra: lint
License-File: LICENSE

============================================
Pure Python implementation of Silicon Heaven
============================================

The implementation of serialized and deserializer for CPON and Chainpack as well
as implementation of `Silicon Heaven RPC
<https://silicon-heaven.github.io/shv-doc/>`__.

* `📃 Sources <https://gitlab.com/elektroline-predator/pyshv>`__
* `⁉️ Issue tracker <https://gitlab.com/elektroline-predator/pyshv/-/issues>`__
* `📕 Documentation <https://elektroline-predator.gitlab.io/pyshv/>`__


Installation
------------

The installation can be done with package manager ``pip``.

.. code-block:: console

   $ pip install pyshv


Running tests
-------------

This project contains tests in directory ``tests``.

Tests require `SHV applications <https://github.com/silicon-heaven/shvapp>`__.

To run tests you have to use **pytest**. To run all tests just run it in the top
level directory of the project. See the `pytest documentation
<https://docs.pytest.org/>`__ for more info.


Documentation
-------------

The documentation is stored in `docs` directory. You can build the latest
version from the source code using:

.. code-block:: console

    $ sphinx-build -b html docs docs-html
