netjsonconfig
=============
.. image:: https://github.com/openwisp/netjsonconfig/workflows/Netjsonconfig%20CI%20Build/badge.svg?branch=master
:target: https://github.com/openwisp/netjsonconfig/actions?query=workflow%3A%22Netjsonconfig+CI+Build%22
.. 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>`_
Raw data
{
"_id": null,
"home_page": "http://netjsonconfig.openwisp.org",
"name": "netjsonconfig",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "openwrt, openwisp, netjson, networking",
"author": "OpenWISP",
"author_email": "support@openwisp.io",
"download_url": "https://files.pythonhosted.org/packages/11/54/6ea2aab9d71dbabbd36a74e0dd46734716b7856487745b662f67f785ac7e/netjsonconfig-1.1.3.tar.gz",
"platform": null,
"description": "netjsonconfig\n=============\n\n.. image:: https://github.com/openwisp/netjsonconfig/workflows/Netjsonconfig%20CI%20Build/badge.svg?branch=master\n :target: https://github.com/openwisp/netjsonconfig/actions?query=workflow%3A%22Netjsonconfig+CI+Build%22\n\n.. image:: https://coveralls.io/repos/openwisp/netjsonconfig/badge.svg\n :target: https://coveralls.io/r/openwisp/netjsonconfig\n\n.. image:: https://img.shields.io/librariesio/release/github/openwisp/netjsonconfig\n :target: https://libraries.io/github/openwisp/netjsonconfig#repository_dependencies\n :alt: Dependency monitoring\n\n.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square\n :target: https://gitter.im/openwisp/general\n\n.. image:: https://badge.fury.io/py/netjsonconfig.svg\n :target: http://badge.fury.io/py/netjsonconfig\n\n.. image:: https://pepy.tech/badge/netjsonconfig\n :target: https://pepy.tech/project/netjsonconfig\n :alt: downloads\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://pypi.org/project/black/\n :alt: code style: black\n\n----\n\nNetjsonconfig is a part of the `OpenWISP project <http://openwisp.org>`_\nand it's the official configuration engine of `OpenWISP 2\n<https://github.com/openwisp/ansible-openwisp2>`_.\n\n.. image:: http://netjsonconfig.openwisp.org/en/latest/_images/openwisp.org.svg\n :target: http://openwisp.org\n\n**netjsonconfig** is a python library that converts `NetJSON\n<http://netjson.org>`_ *DeviceConfiguration* objects into real router\nconfigurations that can be installed on systems like `OpenWRT\n<http://openwrt.org>`_, or `OpenWisp Firmware\n<https://github.com/openwisp/OpenWISP-Firmware>`_.\n\nIts main features are listed below for your reference:\n\n- `OpenWRT <http://openwrt.org>`_ / `LEDE\n <https://www.lede-project.org/>`_ support\n- `OpenWisp Firmware <https://github.com/openwisp/OpenWISP-Firmware>`_\n support\n- `OpenVPN <https://openvpn.net>`_ support\n- `WireGuard <https://www.wireguard.com/>`_ support\n- `ZeroTier <https://www.zerotier.com/>`_ support\n- Possibility to support more firmwares via custom backends\n- Based on the `NetJSON RFC <http://netjson.org/rfc.html>`_\n- **Validation** based on `JSON-Schema <http://json-schema.org/>`_\n- **Templates**: store common configurations in templates\n- **Multiple template inheritance**: reduce repetition to the minimum\n- **File inclusion**: easy inclusion of arbitrary files in configuration\n packages\n- **Variables**: reference variables in the configuration\n- **Command line utility**: easy to use from shell scripts or from other\n programming languages\n\n`Documentation <http://netjsonconfig.openwisp.org/>`_ | `Change log\n<https://github.com/openwisp/netjsonconfig/blob/master/CHANGES.rst>`_ |\n`Support channels <http://openwisp.org/support.html>`_ | `Issue Tracker\n<https://github.com/openwisp/netjsonconfig/issues>`_ | `License\n<https://github.com/openwisp/netjsonconfig/blob/master/LICENSE>`_\n",
"bugtrack_url": null,
"license": "GPL3",
"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.",
"version": "1.1.3",
"project_urls": {
"Download": "https://github.com/openwisp/netjsonconfig/releases",
"Homepage": "http://netjsonconfig.openwisp.org"
},
"split_keywords": [
"openwrt",
" openwisp",
" netjson",
" networking"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "76bbfdf193e1d9ae4bc195e4d0dbec2eea5ddc67b710558bfa64ee39b58cd3fd",
"md5": "5176b2ac48ab577b18fd94877b346d90",
"sha256": "567f352ba79a8790e014888181982ffc26c955d49f18bac9431736e09a2aa5fc"
},
"downloads": -1,
"filename": "netjsonconfig-1.1.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5176b2ac48ab577b18fd94877b346d90",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 109758,
"upload_time": "2025-07-31T17:52:23",
"upload_time_iso_8601": "2025-07-31T17:52:23.883654Z",
"url": "https://files.pythonhosted.org/packages/76/bb/fdf193e1d9ae4bc195e4d0dbec2eea5ddc67b710558bfa64ee39b58cd3fd/netjsonconfig-1.1.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "11546ea2aab9d71dbabbd36a74e0dd46734716b7856487745b662f67f785ac7e",
"md5": "40673b092df20c39ff903c381b3c0cfe",
"sha256": "e423886b999751026711ed20b0b5ebc1a5c8a298e51ea295949c7d3568da6120"
},
"downloads": -1,
"filename": "netjsonconfig-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "40673b092df20c39ff903c381b3c0cfe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 91534,
"upload_time": "2025-07-31T17:52:25",
"upload_time_iso_8601": "2025-07-31T17:52:25.431394Z",
"url": "https://files.pythonhosted.org/packages/11/54/6ea2aab9d71dbabbd36a74e0dd46734716b7856487745b662f67f785ac7e/netjsonconfig-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 17:52:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openwisp",
"github_project": "netjsonconfig",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "jinja2",
"specs": [
[
"~=",
"3.1.6"
]
]
},
{
"name": "jsonschema",
"specs": [
[
"~=",
"4.24.0"
]
]
}
],
"lcname": "netjsonconfig"
}
JSON
