netbox-routing-plugin 1.0.0__tar.gz

netbox_routing_plugin-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_routing_plugin-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include netbox_routing_plugin/templates *
+recursive-include netbox_routing_plugin/static *

netbox_routing_plugin-1.0.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: netbox-routing-plugin
+Version: 1.0.0
+Summary: A NetBox Routing Plugin
+Author: Arturo
+Maintainer: Arturo
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://github.com/baldoarturo/netbox-routing-protocols/blob/main/README.md
+Project-URL: Source, https://github.com/baldoarturo/netbox-routing-protocols
+Project-URL: Tracker, https://github.com/baldoarturo/netbox-routing-protocols/issues
+Keywords: netbox-plugin
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 6
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: System :: Hardware :: Mainframes
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Networking :: Firewalls
+Classifier: Topic :: System :: Operating System
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django-polymorphic
+Requires-Dist: regex
+Dynamic: license-file
+
+# Netbox Routing Protocols
+
+[![PyPI](https://img.shields.io/pypi/v/netbox-routing-plugin.svg)](https://pypi.org/project/netbox-routing-plugin/)
+[![Python](https://img.shields.io/pypi/pyversions/netbox-routing-plugin.svg)](https://pypi.org/project/netbox-routing-plugin/)
+[![NetBox](https://img.shields.io/badge/NetBox-4.7%2B-success.svg)](https://github.com/netbox-community/netbox)
+[![CI](https://github.com/baldoarturo/netbox-routing-protocols/actions/workflows/ci.yml/badge.svg)](https://github.com/baldoarturo/netbox-routing-protocols/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/LICENSE)
+
+A plugin for tracking all kinds of routing information
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/baldoarturo/netbox-routing-protocols/main/docs/images/device-routing-tab.png" alt="The Routing tab of a device, with its static routes, OSPF instances and IS-IS instances" width="900">
+</p>
+
+Every routing protocol of a device in one Routing tab: static routes, OSPF, IS-IS, BGP and EIGRP.
+
+> [!WARNING]
+> **Work in progress, not production ready.** The data model, the API and the migrations can still change between versions. 1.0.0 is the first release on PyPI.
+
+## About this project
+
+This plugin was created by Daniel Sheppard ([`dansheps`](https://github.com/dansheps/netbox-routing)), who is credited as the original author and a historical contributor. The package is now maintained by Arturo ([`baldoarturo`](https://github.com/baldoarturo)). This repository is a fork that is developed with the help of AI, using [Claude Code](https://claude.com/claude-code) to speed up development: Claude writes the code, tests and documentation, and the maintainer sets the direction and reviews and approves the changes.
+
+## Documentation
+
+The documentation for operators and users (every protocol and feature, with the RFC it comes from) is in [`docs/`](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/index.md). Start with [Using the plugin](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/using.md); the [RFC index](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/rfc-index.md) goes from an RFC to the features that use it, and [Development](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/development.md) explains how to work on the docs.
+
+## Features
+
+### Ready
+
+* [Routing objects](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md)
+  * [Prefix lists](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#prefix-lists)
+  * [AS paths](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#as-paths)
+  * [Communities](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#communities) and [community lists](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#community-lists)
+* [Route policies](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#route-policies) (match and set, jump to another policy, final deny, search tool; used by OSPF, IS-IS and EIGRP)
+* [Static routes](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/static.md) (special next hops, interface, route leaking)
+* [OSPF, versions 2 (IPv4) and 3 (IPv6)](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/ospf.md) (instances, areas, interfaces, authentication with key rollover, redistribution, virtual links, ranges, neighbors, traffic engineering, segment routing, fast reroute)
+* [IS-IS](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/isis.md) (instances, levels, interfaces, authentication, redistribution, route leaking, segment routing, Flex-Algo, SRv6)
+* [BGP](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/bgp.md) (instances, address families, peer groups, peers, listen ranges, redistribution, originated networks and aggregates, route policy; RFC 4271 and its extensions)
+* [BFD profiles](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/bfd.md) (timers, Simple Password and Keyed MD5 authentication, single-hop and multihop mode, echo interval; RFC 5880, 5881, 5882, 5883; used by BGP, OSPF and IS-IS)
+* [EIGRP](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/eigrp.md) (named mode only; routers, address families with autonomous system and K values, networks, interfaces with timers, authentication, stub, passive default and bandwidth, summaries, redistribution; RFC 7868)
+
+### Work in progress
+
+Not production ready; the model and the migrations can still change. Each one has a tracking issue.
+
+* Segment routing ([tracking #201](https://github.com/baldoarturo/netbox-routing-protocols/issues/201))
+
+# Requirements
+
+* NetBox 4.7+
+* Python 3.12+
+
+## Compatibility Matrix
+
+| NetBox Version | Plugin Version |
+| -------------- | -------------- |
+| 3.2.x | 0.1.x |
+| 4.1.x | 0.2.x |
+| 4.2.x | 0.3.0 |
+| 4.3.x | 0.3.1 |
+| 4.4.x | 0.3.1 |
+| 4.5.x | 0.4.x |
+| 4.6.x | 0.5.0 |
+| 4.7.x | 1.0.0 and later |
+
+## Installation
+
+Follows the standard [NetBox plugin installation procedure](https://netboxlabs.com/docs/netbox/plugins/#installing-plugins).
+
+> [!NOTE]
+The package is published on PyPI as `netbox-routing-plugin`. You can also install the development version straight from GitHub.
+
+### Bare metal
+
+The steps below assume NetBox lives in `/opt/netbox`; adjust paths to match your environment.
+
+1. Install the package into the NetBox virtual environment:
+
+   ```shell
+   source /opt/netbox/venv/bin/activate
+   pip install netbox-routing-plugin
+   ```
+
+   To install the development version from GitHub instead, use `pip install git+https://github.com/baldoarturo/netbox-routing-protocols.git`.
+
+2. Add it to `local_requirements.txt` so it is reinstalled whenever NetBox is upgraded:
+
+   ```shell
+   echo "git+https://github.com/baldoarturo/netbox-routing-protocols.git" >> /opt/netbox/local_requirements.txt
+   ```
+
+3. Enable the plugin in `configuration.py`:
+
+   ```python
+   PLUGINS = [
+       'netbox_routing_plugin',
+   ]
+   ```
+
+4. Apply the database migrations and collect static files:
+
+   ```shell
+   python3 /opt/netbox/netbox/manage.py migrate
+   python3 /opt/netbox/netbox/manage.py collectstatic --no-input
+   ```
+
+5. Restart NetBox (e.g. `sudo systemctl restart netbox netbox-rq`).
+
+### Docker
+
+Plugins in Docker are installed by building a custom image, not with `pip` inside a running container. Follow the [netbox-docker plugin instructions](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins) and use the same git URL as the package, and `netbox_routing_plugin` as the plugin name in `PLUGINS`. Migrations and `collectstatic` run automatically when the container starts.
+
+## Configuration
+
+None
+
+## Usage
+
+See [Using the plugin](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/using.md): the menu, how the objects relate to each other, bulk import and validation.
+
+## Additional Notes
+
+TBD
+
+## Contribute
+
+Contributions are always welcome!  Please open an issue first before contributing as the scope is going to be kept
+intentionally narrow
+
+Install the pre-commit hooks once in your clone (`pip install pre-commit`, then `pre-commit install`): they run Ruff
+and Black on every commit with the same configuration as the CI, which runs `pre-commit run --all-files` on every pull
+request. See [`dev/README.md`](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/dev/README.md) to run NetBox and the tests.

netbox_routing_plugin-1.0.0/README.md

@@ -0,0 +1,134 @@
+# Netbox Routing Protocols
+
+[![PyPI](https://img.shields.io/pypi/v/netbox-routing-plugin.svg)](https://pypi.org/project/netbox-routing-plugin/)
+[![Python](https://img.shields.io/pypi/pyversions/netbox-routing-plugin.svg)](https://pypi.org/project/netbox-routing-plugin/)
+[![NetBox](https://img.shields.io/badge/NetBox-4.7%2B-success.svg)](https://github.com/netbox-community/netbox)
+[![CI](https://github.com/baldoarturo/netbox-routing-protocols/actions/workflows/ci.yml/badge.svg)](https://github.com/baldoarturo/netbox-routing-protocols/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/LICENSE)
+
+A plugin for tracking all kinds of routing information
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/baldoarturo/netbox-routing-protocols/main/docs/images/device-routing-tab.png" alt="The Routing tab of a device, with its static routes, OSPF instances and IS-IS instances" width="900">
+</p>
+
+Every routing protocol of a device in one Routing tab: static routes, OSPF, IS-IS, BGP and EIGRP.
+
+> [!WARNING]
+> **Work in progress, not production ready.** The data model, the API and the migrations can still change between versions. 1.0.0 is the first release on PyPI.
+
+## About this project
+
+This plugin was created by Daniel Sheppard ([`dansheps`](https://github.com/dansheps/netbox-routing)), who is credited as the original author and a historical contributor. The package is now maintained by Arturo ([`baldoarturo`](https://github.com/baldoarturo)). This repository is a fork that is developed with the help of AI, using [Claude Code](https://claude.com/claude-code) to speed up development: Claude writes the code, tests and documentation, and the maintainer sets the direction and reviews and approves the changes.
+
+## Documentation
+
+The documentation for operators and users (every protocol and feature, with the RFC it comes from) is in [`docs/`](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/index.md). Start with [Using the plugin](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/using.md); the [RFC index](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/rfc-index.md) goes from an RFC to the features that use it, and [Development](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/development.md) explains how to work on the docs.
+
+## Features
+
+### Ready
+
+* [Routing objects](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md)
+  * [Prefix lists](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#prefix-lists)
+  * [AS paths](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#as-paths)
+  * [Communities](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#communities) and [community lists](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#community-lists)
+* [Route policies](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/routing-objects.md#route-policies) (match and set, jump to another policy, final deny, search tool; used by OSPF, IS-IS and EIGRP)
+* [Static routes](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/static.md) (special next hops, interface, route leaking)
+* [OSPF, versions 2 (IPv4) and 3 (IPv6)](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/ospf.md) (instances, areas, interfaces, authentication with key rollover, redistribution, virtual links, ranges, neighbors, traffic engineering, segment routing, fast reroute)
+* [IS-IS](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/isis.md) (instances, levels, interfaces, authentication, redistribution, route leaking, segment routing, Flex-Algo, SRv6)
+* [BGP](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/bgp.md) (instances, address families, peer groups, peers, listen ranges, redistribution, originated networks and aggregates, route policy; RFC 4271 and its extensions)
+* [BFD profiles](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/bfd.md) (timers, Simple Password and Keyed MD5 authentication, single-hop and multihop mode, echo interval; RFC 5880, 5881, 5882, 5883; used by BGP, OSPF and IS-IS)
+* [EIGRP](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/protocols/eigrp.md) (named mode only; routers, address families with autonomous system and K values, networks, interfaces with timers, authentication, stub, passive default and bandwidth, summaries, redistribution; RFC 7868)
+
+### Work in progress
+
+Not production ready; the model and the migrations can still change. Each one has a tracking issue.
+
+* Segment routing ([tracking #201](https://github.com/baldoarturo/netbox-routing-protocols/issues/201))
+
+# Requirements
+
+* NetBox 4.7+
+* Python 3.12+
+
+## Compatibility Matrix
+
+| NetBox Version | Plugin Version |
+| -------------- | -------------- |
+| 3.2.x | 0.1.x |
+| 4.1.x | 0.2.x |
+| 4.2.x | 0.3.0 |
+| 4.3.x | 0.3.1 |
+| 4.4.x | 0.3.1 |
+| 4.5.x | 0.4.x |
+| 4.6.x | 0.5.0 |
+| 4.7.x | 1.0.0 and later |
+
+## Installation
+
+Follows the standard [NetBox plugin installation procedure](https://netboxlabs.com/docs/netbox/plugins/#installing-plugins).
+
+> [!NOTE]
+The package is published on PyPI as `netbox-routing-plugin`. You can also install the development version straight from GitHub.
+
+### Bare metal
+
+The steps below assume NetBox lives in `/opt/netbox`; adjust paths to match your environment.
+
+1. Install the package into the NetBox virtual environment:
+
+   ```shell
+   source /opt/netbox/venv/bin/activate
+   pip install netbox-routing-plugin
+   ```
+
+   To install the development version from GitHub instead, use `pip install git+https://github.com/baldoarturo/netbox-routing-protocols.git`.
+
+2. Add it to `local_requirements.txt` so it is reinstalled whenever NetBox is upgraded:
+
+   ```shell
+   echo "git+https://github.com/baldoarturo/netbox-routing-protocols.git" >> /opt/netbox/local_requirements.txt
+   ```
+
+3. Enable the plugin in `configuration.py`:
+
+   ```python
+   PLUGINS = [
+       'netbox_routing_plugin',
+   ]
+   ```
+
+4. Apply the database migrations and collect static files:
+
+   ```shell
+   python3 /opt/netbox/netbox/manage.py migrate
+   python3 /opt/netbox/netbox/manage.py collectstatic --no-input
+   ```
+
+5. Restart NetBox (e.g. `sudo systemctl restart netbox netbox-rq`).
+
+### Docker
+
+Plugins in Docker are installed by building a custom image, not with `pip` inside a running container. Follow the [netbox-docker plugin instructions](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins) and use the same git URL as the package, and `netbox_routing_plugin` as the plugin name in `PLUGINS`. Migrations and `collectstatic` run automatically when the container starts.
+
+## Configuration
+
+None
+
+## Usage
+
+See [Using the plugin](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/docs/using.md): the menu, how the objects relate to each other, bulk import and validation.
+
+## Additional Notes
+
+TBD
+
+## Contribute
+
+Contributions are always welcome!  Please open an issue first before contributing as the scope is going to be kept
+intentionally narrow
+
+Install the pre-commit hooks once in your clone (`pip install pre-commit`, then `pre-commit install`): they run Ruff
+and Black on every commit with the same configuration as the CI, which runs `pre-commit run --all-files` on every pull
+request. See [`dev/README.md`](https://github.com/baldoarturo/netbox-routing-protocols/blob/main/dev/README.md) to run NetBox and the tests.

netbox_routing_plugin-1.0.0/netbox_routing_plugin/__init__.py

@@ -0,0 +1,29 @@
+from netbox.plugins import PluginConfig
+from importlib.metadata import metadata
+
+plugin = metadata('netbox-routing-plugin')
+
+
+class NetboxRouting(PluginConfig):
+    # The distribution is published as netbox-routing-plugin, but the app
+    # label, URLs and migrations stay under the module name.
+    name = 'netbox_routing_plugin'
+    verbose_name = 'Netbox Routing Protocols'
+    description = plugin.get('Summary')
+    version = plugin.get('Version')
+    author = plugin.get('Author')
+    author_email = plugin.get('Author-email')
+    base_url = 'routing'
+    min_version = '4.7.0'
+    required_settings = []
+    caching_config = {}
+    default_settings = {}
+    graphql_schema = 'graphql.schema.schema'
+
+    def ready(self):
+        super().ready()
+
+        from netbox_routing_plugin import signals  # noqa: F401
+
+
+config = NetboxRouting