raydonetworks/pyang

An extensible YANG validator and converter in python

News

**2015-10-06 - Version 1.6 released **

• pyang can now be installed via PyPi.

• A new plugin 'lint' has been added. It checks if a module follow the generic guidelines defined in RFC 6087. The 'ietf' plugin still exists, but is rewritten to use the new 'lint' plugin.

• By default, pyang now scans the YANG module path recursively, i.e., it searches for YANG modules also in subdirectories to the directories in the load path. This behavior can be disabled with '--no-path-recurse'.

• A bash completions file has been added.

• ... and various other enhancements and bug fixes, see CHANGES.

2014-11-18 - Version 1.5 released

• A new plugin 'check-update' has been added. It can be used to check if a new revision of a module follows the update rules from RFC 6020.

• A new plugin 'omni' has been added. It generates an OmniGraffle script file from a model.

• ... and various other enhancements and bug fixes.

2013-11-11 - Version 1.4.1 released

• Exactly as 1.4, but fixed to that it works with Python 3.

2013-10-24 - Version 1.4 released

• lots of bugfixes

2013-01-31 - Version 1.3 released

• New plugins: hypertree, jstree, jsonxsl, jtox
• lots of bugfixes

2011-07-27 - Version 1.2 released

2011-02-16 - Version 1.1 released

• A new UML plugin has been added. It is used to generate UML diagrams for visualization of YANG data models. See UMLOutput for an example.
• The DSDL plugin is updated to RFC 6110
• ... and various bug fixes.

---

Overview

YANG (RFC 6020) is a data modeling language for NETCONF (RFC 6241), developed by the IETF NETMOD WG.

pyang is a YANG validator, transformator and code generator, written in python. It can be used to validate YANG modules for correctness, to transform YANG modules into other formats, and to generate code from the modules.

Compatibility

pyang is compatible with the following IETF RFCs:

• RFC 6020
• RFC 6087
• RFC 6110
• RFC 6643

Features

• Validate YANG modules.
• Convert YANG modules to YIN, and YIN to YANG.
• Translate YANG data models to DSDL schemas, which can be used for validating various XML instance documents. See InstanceValidation.
• Translate YANG data models to XSD.
• Generate UML diagrams from YANG models. See UMLOutput for an example.
• Generate compact tree representation of YANG models for quick visualization. See TreeOutput for an example.
• Generate a skeleton XML instance document from the data model.
• Schema-aware translation of instance documents encoded in XML to JSON and vice-versa. See XmlJson.
• Plugin framework for simple development of other outputs, such as code generation.

---

Documentation

See Documentation.