Metadata-Version: 2.4
Name: netjsonconfig
Version: 1.2
Summary: Netjsonconfig is a python library that converts NetJSON DeviceConfiguration objects into real router configurations that can be installed on systems like OpenWRT or OpenWisp Firmware.
Home-page: http://netjsonconfig.openwisp.org
Download-URL: https://github.com/openwisp/netjsonconfig/releases
Author: OpenWISP
Author-email: support@openwisp.io
License: GPL3
Keywords: openwrt,openwisp,netjson,networking
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Networking
License-File: LICENSE
Requires-Dist: jinja2~=3.1.6
Requires-Dist: jsonschema~=4.25.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

netjsonconfig
=============

.. image:: https://github.com/openwisp/netjsonconfig/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/openwisp/netjsonconfig/actions/workflows/ci.yml

.. image:: https://coveralls.io/repos/openwisp/netjsonconfig/badge.svg
    :target: https://coveralls.io/r/openwisp/netjsonconfig

.. image:: https://img.shields.io/librariesio/release/github/openwisp/netjsonconfig
    :target: https://libraries.io/github/openwisp/netjsonconfig#repository_dependencies
    :alt: Dependency monitoring

.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square
    :target: https://gitter.im/openwisp/general

.. image:: https://badge.fury.io/py/netjsonconfig.svg
    :target: http://badge.fury.io/py/netjsonconfig

.. image:: https://pepy.tech/badge/netjsonconfig
    :target: https://pepy.tech/project/netjsonconfig
    :alt: downloads

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://pypi.org/project/black/
    :alt: code style: black

----

Netjsonconfig is a part of the `OpenWISP project <http://openwisp.org>`_
and it's the official configuration engine of `OpenWISP 2
<https://github.com/openwisp/ansible-openwisp2>`_.

.. image:: http://netjsonconfig.openwisp.org/en/latest/_images/openwisp.org.svg
    :target: http://openwisp.org

**netjsonconfig** is a python library that converts `NetJSON
<http://netjson.org>`_ *DeviceConfiguration* objects into real router
configurations that can be installed on systems like `OpenWRT
<http://openwrt.org>`_, or `OpenWisp Firmware
<https://github.com/openwisp/OpenWISP-Firmware>`_.

Its main features are listed below for your reference:

- `OpenWRT <http://openwrt.org>`_ / `LEDE
  <https://www.lede-project.org/>`_ support
- `OpenWisp Firmware <https://github.com/openwisp/OpenWISP-Firmware>`_
  support
- `OpenVPN <https://openvpn.net>`_ support
- `WireGuard <https://www.wireguard.com/>`_ support
- `ZeroTier <https://www.zerotier.com/>`_ support
- Possibility to support more firmwares via custom backends
- Based on the `NetJSON RFC <http://netjson.org/rfc.html>`_
- **Validation** based on `JSON-Schema <http://json-schema.org/>`_
- **Templates**: store common configurations in templates
- **Multiple template inheritance**: reduce repetition to the minimum
- **File inclusion**: easy inclusion of arbitrary files in configuration
  packages
- **Variables**: reference variables in the configuration
- **Command line utility**: easy to use from shell scripts or from other
  programming languages

`Documentation <http://netjsonconfig.openwisp.org/>`_ | `Change log
<https://github.com/openwisp/netjsonconfig/blob/master/CHANGES.rst>`_ |
`Support channels <http://openwisp.org/support.html>`_ | `Issue Tracker
<https://github.com/openwisp/netjsonconfig/issues>`_ | `License
<https://github.com/openwisp/netjsonconfig/blob/master/LICENSE>`_
