# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-netbox-acls
VERSION=		1.2.2
KEYWORDS=		python
VARIANTS=		py310 v11
SDESC[py310]=		NetBox plugin for Access List management (3.10)
SDESC[v11]=		NetBox plugin for Access List management (3.11)
HOMEPAGE=		https://github.com/ryanmerolle/netbox-acls
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/07/04/80bbfcb849c875cb51f0df3a6d320b0c753e428215a2ee7872f7d83d9d1d
DISTFILE[1]=		netbox_acls-1.2.2-py3-none-any.whl:main
DF_INDEX=		1
SPKGS[py310]=		single
SPKGS[v11]=		single

OPTIONS_AVAILABLE=	PY310 PY311
OPTIONS_STANDARD=	none
VOPTS[py310]=		PY310=ON PY311=OFF
VOPTS[v11]=		PY310=OFF PY311=ON

DISTNAME=		netbox_acls-1.2.2.dist-info

GENERATED=		yes

[PY310].USES_ON=			python:py310,wheel

[PY311].USES_ON=			python:v11,wheel

[FILE:2559:descriptions/desc.single]
# NetBox Access Lists Plugin

A [Netbox] plugin for Access List management.

## Features

This plugin provides the following models:

- Access Lists
- Access List to Interface Assignment
- Access List Rules (abstract model bassis for other rules)
- Access List Standard Rules
- Access List Extended Rules

## Origin

Based on the NetBox plugin tutorial by [jeremystretch]:

- [demo repository]
- [tutorial]

All credit should go to Jeremy. Thanks, Jeremy!

This project just looks to build on top of this framework and model
presented.

## Contributing

This project is currently maintained jointly by:

- [Abhimanyu Saharan]
- [Ryan Merolle]

See the [CONTRIBUTING] for more information.

## Compatibility

Each Plugin Version listed below has been tested with its corresponding
NetBox Version.

| NetBox Version | Plugin Version |
|:--------------:|:--------------:|
|      3.2       |     1.0.1      |
|      3.3       |     1.1.0      |
|      3.4       |     1.2.2      |

## Installing

For adding to a NetBox Docker setup see
[the general instructions for using netbox-docker with plugins].

You can install with pip:

```bash
pip install netbox-acls
```

or by adding to your `local_requirements.txt` or `plugin_requirements.txt`
(netbox-docker):

```bash
netbox-acls
```

## Configuration

Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
 or if you use netbox-docker, your `/configuration/plugins.py` file :

```python
PLUGINS = [
    "netbox_acls"
]

PLUGINS_CONFIG = {
    "netbox_acls": {
        "top_level_menu": True # If set to True the plugin will add a top
level menu item for the plugin. If set to False the plugin will add a menu
item under the Plugins menu item.  Default is set to True.
    },
}
```

## Developing

### VSCode + Docker + Dev Containers

To develop this plugin further one can use the included .devcontainer
configuration. This configuration creates a docker container which includes
a fully working netbox installation. Currently it should work when using
WSL 2. For this to work make sure you have Docker Desktop installed and the
WSL 2 integrations activated.

1. In the WSL terminal, enter `code` to run Visual studio code.
2. Install the devcontainer extension "ms-vscode-remote.remote-containers"
3. Press Ctrl+Shift+P and use the "Dev Container: Clone Repository in
Container Volume" function to clone this repository. This will take a while
depending on your computer
4. If you'd like the netbox instance to be prepopulated with example data
from [netbox-initializers] run `make  initializers`


[FILE:113:distinfo]
97e6437fd7dd65de36658842afde9943094cd05f5b25b82f2a1d9e8adddb685b        38196 netbox_acls-1.2.2-py3-none-any.whl