devinstall

Installation of the Development Environment

Yangson now uses Poetry for managing dependencies and virtual environments. This simpifies considerably the initial setup of the development environment:

1. Install Poetry, for instance using these instructions.

2. Clone the Yangson project in a directory of your choice:

   git clone git@github.com:CZ-NIC/yangson.git
   cd yangson

3. Install dependencies:

   poetry install

   It is often useful to install other YANG tools, in particular pyang. To do so, use the following command instead:

   poetry install --all-extras

4. Activate the virtual environment:

   eval $(poetry env activate)

5. Check that everything was correctly installed by running

   make test
   cd docs
   make doctest

6. Documentation can be built locally by running

   make html

   in the docs subdirectory.

See Poetry documentation for further details.