Skip to content
Snippets Groups Projects
README.rst 791 B
Newer Older
Ladislav Lhotka's avatar
Ladislav Lhotka committed
.. |date| date::

Ladislav Lhotka's avatar
Ladislav Lhotka committed
******************
Welcome to Yangson
******************

:Author: Ladislav Lhotka <lhotka@nic.cz>
Ladislav Lhotka's avatar
Ladislav Lhotka committed
:Date: |date|
Ladislav Lhotka's avatar
Ladislav Lhotka committed
*Yangson* is a Python 3 library for working with `JSON encoded`_
configuration and state data modelled using the YANG_
data modelling language.
Ladislav Lhotka's avatar
Ladislav Lhotka committed

Installation
============

Ladislav Lhotka's avatar
Ladislav Lhotka committed
::

    python -m pip install yangson

Note that *Yangson* requires Python 3.

Development
===========

* Instructions_ for installing the development environment.
Ladislav Lhotka's avatar
Ladislav Lhotka committed

Links
=====

* `Git repository`_
Ladislav Lhotka's avatar
Ladislav Lhotka committed
* `Documentation`_
Ladislav Lhotka's avatar
Ladislav Lhotka committed
.. _JSON encoded: https://tools.ietf.org/html/rfc7951
.. _YANG: https://tools.ietf.org/html/rfc7950
Ladislav Lhotka's avatar
Ladislav Lhotka committed
.. _Instructions: https://github.com/CZ-NIC/yangson/wiki/devinstall
Ladislav Lhotka's avatar
Ladislav Lhotka committed
.. _Git repository: https://github.com/CZ-NIC/yangson
.. _Documentation: https://yangson.labs.nic.cz