# Wireless Radio Resource Manager
A plugin for [Nautobot](https://github.com/nautobot/nautobot).
## Installation
The plugin is available as a Python package in pypi and can be installed with pip
```shell
pip install nautobot-plugin-w-rrm
```
> The plugin is compatible with Nautobot 1.2.0 and higher
To ensure Wireless Radio Resource Manager is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Nautobot root directory (alongside `requirements.txt`) and list the `nautobot-plugin-w-rrm` package:
```no-highlight
# echo nautobot-plugin-w-rrm >> local_requirements.txt
```
Once installed, the plugin needs to be enabled in your `nautobot_config.py`
```python
# In your nautobot_config.py
PLUGINS = ["nautobot_plugin_w_rrm"]
# PLUGINS_CONFIG = {
# "nautobot_plugin_w_rrm": {
# ADD YOUR SETTINGS HERE
# }
# }
```
The plugin behavior can be controlled with the following list of settings
- TODO
Databases supported:
- Postgres
- Mysql
## Usage
### API
TODO
## Contributing
Pull requests are welcomed and automatically built and tested against multiple version of Python and multiple version of Nautobot through Github Actions.
The project is packaged with a light development environment based on `docker-compose` to help with the local development of the project and to run the tests within Github Actions.
The project is following Network to Code software development guideline and is leveraging:
- Black, Pylint, Bandit and pydocstyle for Python linting and formatting.
- Django unit test to ensure the plugin is working properly.
### Development Environment
The development environment can be used in 2 ways. First, with a local poetry environment if you wish to develop outside of Docker with the caveat of using external services provided by Docker for PostgresQL and Redis. Second, all services are spun up using Docker and a local mount so you can develop locally, but Nautobot is spun up within the Docker container.
Below is a quick start guide if you're already familiar with the development environment provided, but if you're not familiar, please read the [Getting Started Guide](GETTING_STARTED.md).
#### Invoke
The [PyInvoke](http://www.pyinvoke.org/) library is used to provide some helper commands based on the environment. There are a few configuration parameters which can be passed to PyInvoke to override the default configuration:
- `nautobot_ver`: the version of Nautobot to use as a base for any built docker containers (default: latest)
- `project_name`: the default docker compose project name (default: nautobot_plugin_w_rrm)
- `python_ver`: the version of Python to use as a base for any built docker containers (default: 3.7)
- `local`: a boolean flag indicating if invoke tasks should be run on the host or inside the docker containers (default: False, commands will be run in docker containers)
- `compose_dir`: the full path to a directory containing the project compose files
- `compose_files`: a list of compose files applied in order (see [Multiple Compose files](https://docs.docker.com/compose/extends/#multiple-compose-files) for more information)
Using **PyInvoke** these configuration options can be overridden using [several methods](http://docs.pyinvoke.org/en/stable/concepts/configuration.html). Perhaps the simplest is simply setting an environment variable `INVOKE_nautobot_plugin_w_rrm_VARIABLE_NAME` where `VARIABLE_NAME` is the variable you are trying to override. The only exception is `compose_files`, because it is a list it must be overridden in a yaml file. There is an example `invoke.yml` (`invoke.example.yml`) in this directory which can be used as a starting point.
#### Local Poetry Development Environment
1. Copy `development/creds.example.env` to `development/creds.env` (This file will be ignored by Git and Docker)
2. Uncomment the `NAUTOBOT_DB_HOST`, `NAUTOBOT_REDIS_HOST`, and `NAUTOBOT_CONFIG` variables in `development/creds.env`
3. Create an `invoke.yml` file with the following contents at the root of the repo (you can also `cp invoke.example.yml invoke.yml` and edit as necessary):
```yaml
---
{ { cookiecutter.plugin_name } }:
local: true
compose_files:
- "docker-compose.requirements.yml"
```
3. Run the following commands:
```shell
poetry shell
poetry install --extras nautobot
export $(cat development/dev.env | xargs)
export $(cat development/creds.env | xargs)
invoke start && sleep 5
nautobot-server migrate
```
> If you want to develop on the latest develop branch of Nautobot, run the following command: `poetry add --optional git+https://github.com/nautobot/nautobot@develop`. After the `@` symbol must match either a branch or a tag.
4. You can now run nautobot-server commands as you would from the [Nautobot documentation](https://nautobot.readthedocs.io/en/latest/) for example to start the development server:
```shell
nautobot-server runserver 0.0.0.0:8080 --insecure
```
Nautobot server can now be accessed at [http://localhost:8080](http://localhost:8080).
It is typically recommended to launch the Nautobot **runserver** command in a separate shell so you can keep developing and manage the webserver separately.
#### Docker Development Environment
This project is managed by [Python Poetry](https://python-poetry.org/) and has a few requirements to setup your development environment:
1. Install Poetry, see the [Poetry Documentation](https://python-poetry.org/docs/#installation) for your operating system.
2. Install Docker, see the [Docker documentation](https://docs.docker.com/get-docker/) for your operating system.
Once you have Poetry and Docker installed you can run the following commands to install all other development dependencies in an isolated python virtual environment:
```shell
poetry shell
poetry install
invoke start
```
Nautobot server can now be accessed at [http://localhost:8080](http://localhost:8080).
To either stop or destroy the development environment use the following options.
- **invoke stop** - Stop the containers, but keep all underlying systems intact
- **invoke destroy** - Stop and remove all containers, volumes, etc. (This results in data loss due to the volume being deleted)
### CLI Helper Commands
The project is coming with a CLI helper based on [invoke](http://www.pyinvoke.org/) to help setup the development environment. The commands are listed below in 3 categories `dev environment`, `utility` and `testing`.
Each command can be executed with `invoke <command>`. Environment variables `INVOKE_nautobot_plugin_w_rrm_PYTHON_VER` and `INVOKE_nautobot_plugin_w_rrm_NAUTOBOT_VER` may be specified to override the default versions. Each command also has its own help `invoke <command> --help`
#### Docker dev environment
```no-highlight
build Build all docker images.
debug Start Nautobot and its dependencies in debug mode.
destroy Destroy all containers and volumes.
restart Restart Nautobot and its dependencies.
start Start Nautobot and its dependencies in detached mode.
stop Stop Nautobot and its dependencies.
```
#### Utility
```no-highlight
cli Launch a bash shell inside the running Nautobot container.
create-user Create a new user in django (default: admin), will prompt for password.
makemigrations Run Make Migration in Django.
nbshell Launch a nbshell session.
shell-plus Launch a shell_plus session, which uses iPython and automatically imports all models.
```
#### Testing
```no-highlight
bandit Run bandit to validate basic static code security analysis.
black Run black to check that Python files adhere to its style standards.
flake8 This will run flake8 for the specified name and Python version.
pydocstyle Run pydocstyle to validate docstring formatting adheres to NTC defined standards.
pylint Run pylint code analysis.
tests Run all tests for this plugin.
unittest Run Django unit tests for the plugin.
```
### Project Documentation
Project documentation is generated by [mkdocs](https://www.mkdocs.org/) from the documentation located in the docs folder. You can configure [readthedocs.io](https://readthedocs.io/) to point at this folder in your repo. A container hosting the docs will be started using the invoke commands on [http://localhost:8001](http://localhost:8001), as changes are saved the docs will be automatically reloaded.
## Questions
For any questions or comments, please check the [FAQ](FAQ.md) first and feel free to swing by the [Network to Code slack channel](https://networktocode.slack.com/) (channel #networktocode).
Sign up [here](http://slack.networktocode.com/)
## Screenshots
TODO
# nautobot-plugin-nautobot-plugin-w-rrm
Raw data
{
"_id": null,
"home_page": "https://github.com/netg-co/nautobot-plugin-w-rrm",
"name": "nautobot-plugin-w-rrm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "nautobot,nautobot-plugin,rrm,wireless,radio,rf",
"author": "Hugo Tinoco",
"author_email": "hugo@dev-knot.com",
"download_url": "https://files.pythonhosted.org/packages/de/f0/eed9bff3c031d5134fb8ff26aa52c39bb3331bc70a02ab8a33fe85866f0a/nautobot_plugin_w_rrm-1.1.0.tar.gz",
"platform": null,
"description": "# Wireless Radio Resource Manager\n\nA plugin for [Nautobot](https://github.com/nautobot/nautobot).\n\n## Installation\n\nThe plugin is available as a Python package in pypi and can be installed with pip\n\n```shell\npip install nautobot-plugin-w-rrm\n```\n\n> The plugin is compatible with Nautobot 1.2.0 and higher\n\nTo ensure Wireless Radio Resource Manager is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Nautobot root directory (alongside `requirements.txt`) and list the `nautobot-plugin-w-rrm` package:\n\n```no-highlight\n# echo nautobot-plugin-w-rrm >> local_requirements.txt\n```\n\nOnce installed, the plugin needs to be enabled in your `nautobot_config.py`\n\n```python\n# In your nautobot_config.py\nPLUGINS = [\"nautobot_plugin_w_rrm\"]\n\n# PLUGINS_CONFIG = {\n# \"nautobot_plugin_w_rrm\": {\n# ADD YOUR SETTINGS HERE\n# }\n# }\n```\n\nThe plugin behavior can be controlled with the following list of settings\n\n- TODO\n\nDatabases supported:\n\n- Postgres\n- Mysql\n\n## Usage\n\n### API\n\nTODO\n\n## Contributing\n\nPull requests are welcomed and automatically built and tested against multiple version of Python and multiple version of Nautobot through Github Actions.\n\nThe project is packaged with a light development environment based on `docker-compose` to help with the local development of the project and to run the tests within Github Actions.\n\nThe project is following Network to Code software development guideline and is leveraging:\n\n- Black, Pylint, Bandit and pydocstyle for Python linting and formatting.\n- Django unit test to ensure the plugin is working properly.\n\n### Development Environment\n\nThe development environment can be used in 2 ways. First, with a local poetry environment if you wish to develop outside of Docker with the caveat of using external services provided by Docker for PostgresQL and Redis. Second, all services are spun up using Docker and a local mount so you can develop locally, but Nautobot is spun up within the Docker container.\n\nBelow is a quick start guide if you're already familiar with the development environment provided, but if you're not familiar, please read the [Getting Started Guide](GETTING_STARTED.md).\n\n#### Invoke\n\nThe [PyInvoke](http://www.pyinvoke.org/) library is used to provide some helper commands based on the environment. There are a few configuration parameters which can be passed to PyInvoke to override the default configuration:\n\n- `nautobot_ver`: the version of Nautobot to use as a base for any built docker containers (default: latest)\n- `project_name`: the default docker compose project name (default: nautobot_plugin_w_rrm)\n- `python_ver`: the version of Python to use as a base for any built docker containers (default: 3.7)\n- `local`: a boolean flag indicating if invoke tasks should be run on the host or inside the docker containers (default: False, commands will be run in docker containers)\n- `compose_dir`: the full path to a directory containing the project compose files\n- `compose_files`: a list of compose files applied in order (see [Multiple Compose files](https://docs.docker.com/compose/extends/#multiple-compose-files) for more information)\n\nUsing **PyInvoke** these configuration options can be overridden using [several methods](http://docs.pyinvoke.org/en/stable/concepts/configuration.html). Perhaps the simplest is simply setting an environment variable `INVOKE_nautobot_plugin_w_rrm_VARIABLE_NAME` where `VARIABLE_NAME` is the variable you are trying to override. The only exception is `compose_files`, because it is a list it must be overridden in a yaml file. There is an example `invoke.yml` (`invoke.example.yml`) in this directory which can be used as a starting point.\n\n#### Local Poetry Development Environment\n\n1. Copy `development/creds.example.env` to `development/creds.env` (This file will be ignored by Git and Docker)\n2. Uncomment the `NAUTOBOT_DB_HOST`, `NAUTOBOT_REDIS_HOST`, and `NAUTOBOT_CONFIG` variables in `development/creds.env`\n3. Create an `invoke.yml` file with the following contents at the root of the repo (you can also `cp invoke.example.yml invoke.yml` and edit as necessary):\n\n```yaml\n---\n{ { cookiecutter.plugin_name } }:\n local: true\n compose_files:\n - \"docker-compose.requirements.yml\"\n```\n\n3. Run the following commands:\n\n```shell\npoetry shell\npoetry install --extras nautobot\nexport $(cat development/dev.env | xargs)\nexport $(cat development/creds.env | xargs)\ninvoke start && sleep 5\nnautobot-server migrate\n```\n\n> If you want to develop on the latest develop branch of Nautobot, run the following command: `poetry add --optional git+https://github.com/nautobot/nautobot@develop`. After the `@` symbol must match either a branch or a tag.\n\n4. You can now run nautobot-server commands as you would from the [Nautobot documentation](https://nautobot.readthedocs.io/en/latest/) for example to start the development server:\n\n```shell\nnautobot-server runserver 0.0.0.0:8080 --insecure\n```\n\nNautobot server can now be accessed at [http://localhost:8080](http://localhost:8080).\n\nIt is typically recommended to launch the Nautobot **runserver** command in a separate shell so you can keep developing and manage the webserver separately.\n\n#### Docker Development Environment\n\nThis project is managed by [Python Poetry](https://python-poetry.org/) and has a few requirements to setup your development environment:\n\n1. Install Poetry, see the [Poetry Documentation](https://python-poetry.org/docs/#installation) for your operating system.\n2. Install Docker, see the [Docker documentation](https://docs.docker.com/get-docker/) for your operating system.\n\nOnce you have Poetry and Docker installed you can run the following commands to install all other development dependencies in an isolated python virtual environment:\n\n```shell\npoetry shell\npoetry install\ninvoke start\n```\n\nNautobot server can now be accessed at [http://localhost:8080](http://localhost:8080).\n\nTo either stop or destroy the development environment use the following options.\n\n- **invoke stop** - Stop the containers, but keep all underlying systems intact\n- **invoke destroy** - Stop and remove all containers, volumes, etc. (This results in data loss due to the volume being deleted)\n\n### CLI Helper Commands\n\nThe project is coming with a CLI helper based on [invoke](http://www.pyinvoke.org/) to help setup the development environment. The commands are listed below in 3 categories `dev environment`, `utility` and `testing`.\n\nEach command can be executed with `invoke <command>`. Environment variables `INVOKE_nautobot_plugin_w_rrm_PYTHON_VER` and `INVOKE_nautobot_plugin_w_rrm_NAUTOBOT_VER` may be specified to override the default versions. Each command also has its own help `invoke <command> --help`\n\n#### Docker dev environment\n\n```no-highlight\n build Build all docker images.\n debug Start Nautobot and its dependencies in debug mode.\n destroy Destroy all containers and volumes.\n restart Restart Nautobot and its dependencies.\n start Start Nautobot and its dependencies in detached mode.\n stop Stop Nautobot and its dependencies.\n```\n\n#### Utility\n\n```no-highlight\n cli Launch a bash shell inside the running Nautobot container.\n create-user Create a new user in django (default: admin), will prompt for password.\n makemigrations Run Make Migration in Django.\n nbshell Launch a nbshell session.\n shell-plus Launch a shell_plus session, which uses iPython and automatically imports all models.\n```\n\n#### Testing\n\n```no-highlight\n bandit Run bandit to validate basic static code security analysis.\n black Run black to check that Python files adhere to its style standards.\n flake8 This will run flake8 for the specified name and Python version.\n pydocstyle Run pydocstyle to validate docstring formatting adheres to NTC defined standards.\n pylint Run pylint code analysis.\n tests Run all tests for this plugin.\n unittest Run Django unit tests for the plugin.\n```\n\n### Project Documentation\n\nProject documentation is generated by [mkdocs](https://www.mkdocs.org/) from the documentation located in the docs folder. You can configure [readthedocs.io](https://readthedocs.io/) to point at this folder in your repo. A container hosting the docs will be started using the invoke commands on [http://localhost:8001](http://localhost:8001), as changes are saved the docs will be automatically reloaded.\n\n## Questions\n\nFor any questions or comments, please check the [FAQ](FAQ.md) first and feel free to swing by the [Network to Code slack channel](https://networktocode.slack.com/) (channel #networktocode).\nSign up [here](http://slack.networktocode.com/)\n\n## Screenshots\n\nTODO\n\n# nautobot-plugin-nautobot-plugin-w-rrm\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Wireless Radio Resource Manager",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/netg-co/nautobot-plugin-w-rrm",
"Repository": "https://github.com/netg-co/nautobot-plugin-w-rrm"
},
"split_keywords": [
"nautobot",
"nautobot-plugin",
"rrm",
"wireless",
"radio",
"rf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2806084cc0301fa2eb526a04ba62928658e494e93f08103f6f04378847437d50",
"md5": "d3c4377aca88f432354b927ac90d300a",
"sha256": "38f21c7570fc13e569f86cc6a95565a6ce48a5fbb52e3369f7a0f0bfaba501db"
},
"downloads": -1,
"filename": "nautobot_plugin_w_rrm-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3c4377aca88f432354b927ac90d300a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 57464,
"upload_time": "2024-03-12T05:41:11",
"upload_time_iso_8601": "2024-03-12T05:41:11.268515Z",
"url": "https://files.pythonhosted.org/packages/28/06/084cc0301fa2eb526a04ba62928658e494e93f08103f6f04378847437d50/nautobot_plugin_w_rrm-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "def0eed9bff3c031d5134fb8ff26aa52c39bb3331bc70a02ab8a33fe85866f0a",
"md5": "cdce0f4a80f550113d976d41c05194fe",
"sha256": "d40ee43f44fdcaae7246d8598917c0cf04aa8c9d3137a2617f5142952c670fdb"
},
"downloads": -1,
"filename": "nautobot_plugin_w_rrm-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cdce0f4a80f550113d976d41c05194fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 40479,
"upload_time": "2024-03-12T05:41:13",
"upload_time_iso_8601": "2024-03-12T05:41:13.480777Z",
"url": "https://files.pythonhosted.org/packages/de/f0/eed9bff3c031d5134fb8ff26aa52c39bb3331bc70a02ab8a33fe85866f0a/nautobot_plugin_w_rrm-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 05:41:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "netg-co",
"github_project": "nautobot-plugin-w-rrm",
"github_not_found": true,
"lcname": "nautobot-plugin-w-rrm"
}
JSON
