Ravenport: python-phonebox-plugin

Subpackage Descriptions

single

# PhoneBox Plugin A Telephone Number Management Plugin for [NetBox] and more. >The plugin versions 0.0.1b1-0.0.1b4 support NetBox 2.10.x versions. > >Latest plugin version 0.0.1b5 supports NetBox 2.11.0+ versions I described some general considerations behind the plugin development and future plans in my [blog post]. ### Preview ![](docs/media/preview_01.png) # Supported Features and Models ### Numbers The plugin currently implements a Number abstraction representing a single telephone number of an arbitrary format.
A Number can consist of valid DTMF characters and leading plus sign for E.164 support: - leading plus ("+") sign (optional) - digits 0-9 - characters A, B, C, D - pound sign ("#") - asterisk sign ("*") Sample valid numbers: +12341234567, 1000, 123#2341234567, *100#.
Numbers are stored without delimiters. They will be implemented as an additional formatting function.
Number values can be not unique. Tenant is a mandatory option representing a number partition. Number and Tenant are globally unique.
A Number can optionally be assigned with Provider and Region relations.
A Number can contain an optional Description.
A Number can optionally be tagged with Tags.

The plugin supports Bulk Edit and Delete operations for Numbers. ### Voice Circuits Voice Circuit is an entity on a voice-enabled device representing a physical or virtual connection to another voice-enabled device. The plugin supports the following voice circuit types: - SIP Trunk. - Digital Voice Circuit (PRI/BRI/etc). - Analog Voice Circuit (CO lines/etc). A Voice Circuit must be assigned to an interface of a Device or Virtual Machine. ### Plugin API The plugin introduces a NetBox REST API extension `/api/plugins/phonebox/`.
It currently supports all create, read, update, and delete operations for Numbers via `/api/plugins/phonebox/numbers/`.
The API is compatible with [pynetbox]: ``` >>> nb.plugins.phonebox.numbers.get(7) 2000 >>> ``` # Installation General installation steps and considerations follow the [official guidelines]. ### Package Installation from PyPi Assuming you use a Virtual Environment for Netbox: ``` $ source /opt/netbox/venv/bin/activate (venv) $ pip3 install phonebox-plugin ``` ### Package Installation from Source Code The source code is available on [GitHub].
Download and install the package. Assuming you use a Virtual Environment for Netbox: ``` $ git clone https://github.com/iDebugAll/phonebox_plugin $ cd phonebox_plugin $ source /opt/netbox/venv/bin/activate (venv) $ pip3 install . ``` To ensure NextBox UI plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the NetBox root directory (alongside `requirements.txt`) and list the `phonebox_plugin` package: ```no-highlight # echo phonebox_plugin >> local_requirements.txt ```

Port variant	py310
Summary	Phone numbers management plugin for NetBox (3.10)
Package version	0.0.6b1
Homepage	https://github.com/iDebugAll/phonebox_plugin
Keywords	python
Maintainer	Python Automaton
License	Not yet specified
Other variants	v11
Ravenports	Buildsheet \| History
Ravensource	Port Directory \| History
Last modified	19 MAY 2023, 17:01:37 UTC
Port created	07 JAN 2023, 04:18:24 UTC

Build (only)	python-setuptools:single:py310 autoselect-python:single:standard
Build and Runtime	python310:single:standard