Skip to main content

Library to help parsing/translating YANG models from/to native text/structures

Project description

Yangify

Yangify is a framework that allows you to easily write code that can map structured and unstructured data into data modelled using YANG models. Yangify can also do the opposite operation and convert data modelled with YANG models into other structured or non-structured data. This allows you to easily write code that can parse native output/data/configuration from network devices and map them into YANG models and vice-versa.

Installing yangify

You can install yangify with pip:

pip install yangify

Ways to Get Started with Yangify

Start Executing Yangify Juptyer Notebooks

Step 1

Clone the repository:

$ git clone https://github.com/networktocode/yangify

Step 2

Navigate into yangify:

$ cd yangify

Step 3

Build the containers needed.

$ make build_test_containers 

Step 4

Start a container so you can run Jupyter notebooks:

make dev_jupyter

Step 5

Lanunch a browser and navigate to the following URL:

http://127.0.0.1:8888

You will find all of the notebooks in docs/tutorials and also docs/tutorials/parsing-quickstart.

These same notebooks can be viewed without being interactive in the Read the Docs.

Go Right into a Working Yangify Dev Environment

Note: this dev environment is built for parsing.

Step 1

Clone the repository:

$ git clone https://github.com/networktocode/yangify

Step 2

Navigate into yangify:

$ cd yangify

Step 3

Build the containers needed.

$ make build_test_containers 

Step 4

Create a container that you'll use for development & testing. This container will get built such that you can modify files in your local directory and execute them within the container environment. Great for using your local text editor and executing in pre-buit enviornment.

make enter_dev_container

This will drop you right into the container.

Step 5

Install yangify with make install:

root@e726de8f2226:/yangify# make install
poetry install
Skipping virtualenv creation, as specified in config file.
Installing dependencies from lock file

Nothing to install or update

  - Installing yangify (0.1.0)
A setup.py file already exists. Using it.
root@e726de8f2226:/yangify#

Step 6

Navigate into the parsing-quickstart directory (inside the container):

root@e726de8f2226:/yangify# cd docs/tutorials/parsing-quickstart/
root@e726de8f2226:/yangify/docs/tutorials/parsing-quickstart# 

Step 7

Try out the dev-yangify.py script:

root@e726de8f2226:/yangify/docs/tutorials/parsing-quickstart# python dev-yangify.py --vlans
{
    "openconfig-vlan:vlans": {
        "vlan": [
            {
                "vlan-id": 10,
                "config": {
                    "vlan-id": 10,
                    "status": "ACTIVE"
                }
            },
            {
                "vlan-id": 20,
                "config": {
                    "vlan-id": 20,
                    "name": "web_vlan",
                    "status": "ACTIVE"
                }
            },
            {
                "vlan-id": 30,
                "config": {
                    "vlan-id": 30,
                    "name": "test_vlan",
                    "status": "ACTIVE"
                }
            }
        ]
    }
}
root@e726de8f2226:/yangify/docs/tutorials/parsing-quickstart# 

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for yangify, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size yangify-0.1.2-py3-none-any.whl (22.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size yangify-0.1.2.tar.gz (19.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page