bucket_D3/python-netbox-acls

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-netbox-acls
   4 VERSION=                1.2.2
   5 KEYWORDS=               python
   6 VARIANTS=               py310 v11
   7 SDESC[py310]=           NetBox plugin for Access List management (3.10)
   8 SDESC[v11]=             NetBox plugin for Access List management (3.11)
   9 HOMEPAGE=               https://github.com/ryanmerolle/netbox-acls
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/07/04/80bbfcb849c875cb51f0df3a6d320b0c753e428215a2ee7872f7d83d9d1d
  14 DISTFILE[1]=            netbox_acls-1.2.2-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[v11]=             single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[v11]=             PY310=OFF PY311=ON
  23
  24 DISTNAME=               netbox_acls-1.2.2.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].USES_ON=                        python:py310,wheel
  29
  30 [PY311].USES_ON=                        python:v11,wheel
  31
  32 [FILE:2559:descriptions/desc.single]
  33 # NetBox Access Lists Plugin
  34
  35 A [Netbox] plugin for Access List management.
  36
  37 ## Features
  38
  39 This plugin provides the following models:
  40
  41 - Access Lists
  42 - Access List to Interface Assignment
  43 - Access List Rules (abstract model bassis for other rules)
  44 - Access List Standard Rules
  45 - Access List Extended Rules
  46
  47 ## Origin
  48
  49 Based on the NetBox plugin tutorial by [jeremystretch]:
  50
  51 - [demo repository]
  52 - [tutorial]
  53
  54 All credit should go to Jeremy. Thanks, Jeremy!
  55
  56 This project just looks to build on top of this framework and model
  57 presented.
  58
  59 ## Contributing
  60
  61 This project is currently maintained jointly by:
  62
  63 - [Abhimanyu Saharan]
  64 - [Ryan Merolle]
  65
  66 See the [CONTRIBUTING] for more information.
  67
  68 ## Compatibility
  69
  70 Each Plugin Version listed below has been tested with its corresponding
  71 NetBox Version.
  72
  73 | NetBox Version | Plugin Version |
  74 |:--------------:|:--------------:|
  75 |      3.2       |     1.0.1      |
  76 |      3.3       |     1.1.0      |
  77 |      3.4       |     1.2.2      |
  78
  79 ## Installing
  80
  81 For adding to a NetBox Docker setup see
  82 [the general instructions for using netbox-docker with plugins].
  83
  84 You can install with pip:
  85
  86 ```bash
  87 pip install netbox-acls
  88 ```
  89
  90 or by adding to your `local_requirements.txt` or `plugin_requirements.txt`
  91 (netbox-docker):
  92
  93 ```bash
  94 netbox-acls
  95 ```
  96
  97 ## Configuration
  98
  99 Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
 100  or if you use netbox-docker, your `/configuration/plugins.py` file :
 101
 102 ```python
 103 PLUGINS = [
 104     "netbox_acls"
 105 ]
 106
 107 PLUGINS_CONFIG = {
 108     "netbox_acls": {
 109         "top_level_menu": True # If set to True the plugin will add a top
 110 level menu item for the plugin. If set to False the plugin will add a menu
 111 item under the Plugins menu item.  Default is set to True.
 112     },
 113 }
 114 ```
 115
 116 ## Developing
 117
 118 ### VSCode + Docker + Dev Containers
 119
 120 To develop this plugin further one can use the included .devcontainer
 121 configuration. This configuration creates a docker container which includes
 122 a fully working netbox installation. Currently it should work when using
 123 WSL 2. For this to work make sure you have Docker Desktop installed and the
 124 WSL 2 integrations activated.
 125
 126 1. In the WSL terminal, enter `code` to run Visual studio code.
 127 2. Install the devcontainer extension "ms-vscode-remote.remote-containers"
 128 3. Press Ctrl+Shift+P and use the "Dev Container: Clone Repository in
 129 Container Volume" function to clone this repository. This will take a while
 130 depending on your computer
 131 4. If you'd like the netbox instance to be prepopulated with example data
 132 from [netbox-initializers] run `make  initializers`
 133
 134
 135 [FILE:113:distinfo]
 136 97e6437fd7dd65de36658842afde9943094cd05f5b25b82f2a1d9e8adddb685b        38196 netbox_acls-1.2.2-py3-none-any.whl
 137