PyCyphal documentation
======================

PyCyphal is a full-featured implementation of the `Cyphal protocol stack <https://opencyphal.org>`_ in Python.
PyCyphal aims to support all features and transport layers of UAVCAN,
be portable across all major platforms supporting Python, and
be extensible to permit low-effort experimentation and testing of new protocol capabilities.

Start reading this documentation from the first chapter -- :ref:`architecture`.
If you have questions, please bring them to the `support forum <https://forum.opencyphal.org/>`_.


Contents
--------

.. toctree::
   :maxdepth: 2

   pages/architecture
   pages/installation
   pages/api
   pages/demo
   pages/faq
   pages/changelog
   pages/dev


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


See also
--------

Related projects built on top of PyCyphal:

- `Yakut <https://github.com/OpenCyphal/yakut>`_ ---
  a command-line interface utility for diagnostics and management of Cyphal networks.


License
-------

.. include:: ../LICENSE