Metadata-Version: 2.4
Name: pyshv
Version: 0.10.0
Summary: Pure Python SHV implementation
Author: Elektroline a.s.
License-Expression: MIT
Project-URL: Homepage, https://gitlab.com/silicon-heaven/pyshv
Project-URL: Bug Tracker, https://gitlab.com/silicon-heaven/pyshv/-/issues
Project-URL: Github, https://github.com/silicon-heaven/libshv-py
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Networking
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Provides-Extra: websockets
Requires-Dist: websockets>=13.0; extra == "websockets"
Provides-Extra: extra
Requires-Dist: asyncinotify; sys_platform == "linux" and extra == "extra"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-asyncio; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: sphinx-mdinclude; extra == "docs"
Requires-Dist: sphinx-multiversion; extra == "docs"
Dynamic: license-file

============================================
Pure Python implementation of Silicon Heaven
============================================
.. image:: https://gitlab.com/silicon-heaven/pyshv/-/raw/master/docs/_static/logo.svg
   :align: right
   :height: 128px

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/silicon-heaven/pyshv>`__
* `⁉️ Issue tracker <https://gitlab.com/silicon-heaven/pyshv/-/issues>`__
* `📕 Documentation <https://silicon-heaven.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; 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 <https://docs.pytest.org/>`__ for more info.


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

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

.. code-block:: console

    $ sphinx-build -b html docs docs-html
