https://github.com/hellerve/netbox_example_plugin
An example plugin for Netbox
https://github.com/hellerve/netbox_example_plugin
Last synced: about 1 year ago
JSON representation
An example plugin for Netbox
- Host: GitHub
- URL: https://github.com/hellerve/netbox_example_plugin
- Owner: hellerve
- Created: 2019-05-16T21:45:13.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-23T18:33:07.000Z (about 7 years ago)
- Last Synced: 2025-02-12T05:12:15.370Z (over 1 year ago)
- Language: Python
- Size: 4.88 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# netbox\_example\_plugin
This is an example plugin for the plugin system proposed for Netbox.
## Layout
The plugin registry happens in the module’s `__init__.py`, to assure that it is
run on module import. It’s the entry point into the module.
The rest of the plugin is just a silly Django app that adds a single model to
the core of Netbox, a [widget](netbox_example_plugin/templates/example/widget.html),
and a [navigation bar extension](netbox_example_plugin/templates/example/navbar.html).
## Installation
You should be able to add it into Netbox by adding the following line to
Netbox’s `requirement.txt` file and installing the requirements:
```
-e git+http://github.com/hellerve/netbox-example-plugin.git#egg=netbox-example-plugin
```
Then you can enable it by adding the following line to your `configuration.py`:
```python
INSTALLED_APPS = [
'netbox_example_plugin',
]
```
Have fun!