YANGcore

YANGcore is a Python based application server having a RESTCONF-based interface binding to a SQL Alchemy-based database backend.

Installation

pip install yangcore

Overview

• HTTPS or HTTP
• RESTCONF HEAD, GET, POST, PUT, DELETE, and PATCH work over entire tree.
• Ordered-by user query parameters ('insert' and 'point') work.
• List Pagination query parameters ('limit', 'offset', and 'direction') work.
• The ./well-known/host-meta, RESTCONF root (i.e., {+restconf}), and YANG-library resources.
• Tested using in-memory, file-base, MySQL and, a long time ago, AWS Aurora and Postgres.
• TLS connection to backend RDBMS, with or w/o client certificate.
• Logging and dynamic callouts for Audit log and Notifications log
• Database-level transactions and concurrent access.
• In-memory database support for ephemeral use-cases.
• Lightweight and fast: single-threaded Asynchronous I/O.
• Python 3.11 and 3.12

Motivation

RESTCONF is great REST API right out of the box. The API is auto-generated off of a collection of YANG modules, which defines the API contract. YANG is the popular data modelling langauge defined by the IETF (RFC 7950)and recommended by the Internet Architecture Board.

As far as APIs go, RESTCONF (RFC 8040) scores high on both the Richardson Maturity Model and the Amundsen Maturity Model models. See API Maturity for a description for what makes for a good API.

Python is a popular programming language. A Python implementation of a RESTCONF server seems like it could be popular. Searching for Python-based RESTCONF tooling found Jetconf, but its been abandoned.

Thus there seemed to be an opportunity to work and YANGcore became something.

More Information

Please see the documentation for more information.