netbox-rack-design 0.1.0__tar.gz

netbox_rack_design-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,121 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## General Tips for Working on GitHub
+
+* Register for a free [GitHub account](https://github.com/signup) if you haven't already.
+* You can use [GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting text and adding images.
+* To help mitigate notification spam, please avoid "bumping" issues with no activity. (To vote an issue up or down, use a :thumbsup: or :thumbsdown: reaction.)
+* Please avoid pinging members with `@` unless they've previously expressed interest or involvement with that particular issue.
+* Familiarize yourself with [this list of discussion anti-patterns](https://github.com/bradfitz/issue-tracker-behaviors) and make every effort to avoid them.
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at https://github.com/ravenrs/netbox-rack-design/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+NetBox Rack Design could always use more documentation, whether as part of the
+official NetBox Rack Design docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/ravenrs/netbox-rack-design/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `netbox-rack-design` for local development.
+
+1. Fork the `netbox-rack-design` repo on GitHub.
+2. Clone your fork locally
+
+    ```
+    $ git clone git@github.com:your_name_here/netbox-rack-design.git
+    ```
+
+3. Activate the NetBox virtual environment (see the NetBox documentation under [Setting up a Development Environment](https://docs.netbox.dev/en/stable/development/getting-started/)):
+
+    ```
+    $ source ~/.venv/netbox/bin/activate
+    ```
+
+4. Add the plugin to NetBox virtual environment in Develop mode (see [Plugins Development](https://docs.netbox.dev/en/stable/plugins/development/)):
+
+    To ease development, it is recommended to go ahead and install the plugin at this point using setuptools' develop mode. This will create symbolic links within your Python environment to the plugin development directory. Call setup.py from the plugin's root directory with the develop argument (instead of install):
+
+    ```
+    $ python setup.py develop
+    ```
+
+5. Create a branch for local development:
+
+    ```
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+6. Commit your changes and push your branch to GitHub:
+
+    ```
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+7. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.md.
+3. The pull request should work for Python 3.12, 3.13, and 3.14. Check
+   https://github.com/ravenrs/netbox-rack-design/actions
+   and make sure that the tests pass for all supported Python versions.
+
+
+## Deploying
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in CHANGELOG.md) and that all tests pass.
+Then in the github project go to `Releases` and create a new release with a new tag.  This will automatically upload the release to pypi:

netbox_rack_design-0.1.0/LICENSE

@@ -0,0 +1 @@
+

netbox_rack_design-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include CONTRIBUTING.md
+include LICENSE
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+
+graft templates

netbox_rack_design-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: netbox-rack-design
+Version: 0.1.0
+Summary: NetBox plugin for Rack Design.
+Author-email: Petr Voronov <ravenrs@gmail.com>
+Project-URL: Documentation, https://github.com/ravenrs/netbox-rack-design/blob/main/README.md
+Project-URL: Source, https://github.com/ravenrs/netbox-rack-design
+Project-URL: Tracker, https://github.com/ravenrs/netbox-rack-design/issues
+Keywords: netbox,netbox-plugin
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: check-manifest==0.51; extra == "test"
+Requires-Dist: ruff==0.14.14; extra == "test"
+Requires-Dist: pre-commit==6.0.0; extra == "test"
+Requires-Dist: pytest==9.0.2; extra == "test"
+Dynamic: license-file
+
+# NetBox Rack Design
+
+NetBox plugin for Rack Design.
+
+
+* Free software: Apache-2.0
+* Documentation: https://ravenrs.github.io/netbox-rack-design/
+
+
+## Features
+
+The features the plugin provides should be listed here. For example:
+
+- Manage Rack Design resources through NetBox UI
+- Track and organize Rack Design data with custom fields and tags
+- REST API endpoints for programmatic access
+- GraphQL support for flexible data queries
+- Full change logging and journaling support
+- Integration with NetBox's permission system
+- Global search integration for finding Rack Design objects
+- Comprehensive filtering and table views
+
+## Screenshots
+
+<!-- Add screenshots or GIFs demonstrating your plugin's functionality here -->
+_Screenshots will be added as features are developed._
+
+## Compatibility
+
+This plugin targets **NetBox 4.4.x**.
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     4.4.x      |      0.1.0     |
+
+For more detailed compatibility information, see [COMPATIBILITY.md](COMPATIBILITY.md).
+
+## Dependencies
+
+This plugin requires:
+- NetBox 4.4.0 – 4.4.x
+- Python 3.10 – 3.12
+
+No additional Python packages are required beyond NetBox's core dependencies.
+
+## REST API
+
+This plugin provides a REST API endpoint for managing Rack Design resources:
+
+- `/api/plugins/netbox_rack_design/rack-designs/` - List and create Rackdesign objects
+
+
+## GraphQL
+
+This plugin provides GraphQL support for querying Rack Design resources through NetBox's GraphQL API.
+
+
+## Installing
+
+For adding to a NetBox Docker setup see
+[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+While this is still in development and not yet on pypi you can install with pip:
+
+```bash
+pip install git+https://github.com/ravenrs/netbox-rack-design
+```
+
+or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
+
+```bash
+git+https://github.com/ravenrs/netbox-rack-design
+```
+
+Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
+ or if you use netbox-docker, your `/configuration/plugins.py` file :
+
+```python
+PLUGINS = [
+    'netbox_rack_design'
+]
+
+PLUGINS_CONFIG = {
+    "netbox_rack_design": {},
+}
+```
+
+## Configuration
+
+This plugin does not require any additional configuration by default. Optional configuration parameters can be added to `PLUGINS_CONFIG` in your NetBox configuration file as needed.
+
+## Usage
+
+For detailed usage instructions, please refer to the [documentation](https://ravenrs.github.io/netbox-rack-design/).
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+### Reporting Bugs
+
+Please report bugs by opening an issue on our [GitHub Issues](https://github.com/ravenrs/netbox-rack-design/issues) page. When reporting bugs, please include:
+
+- NetBox version
+- Plugin version
+- Python version
+- Steps to reproduce
+- Expected behavior
+- Actual behavior
+
+### Feature Requests
+
+Feature requests can be submitted as [GitHub Issues](https://github.com/ravenrs/netbox-rack-design/issues) with the "enhancement" label.
+
+## Support
+
+- **Documentation**: https://ravenrs.github.io/netbox-rack-design/
+- **Issues**: https://github.com/ravenrs/netbox-rack-design/issues
+- **Discussions**: https://github.com/ravenrs/netbox-rack-design/discussions
+- **NetBox Community Slack**: [netdev-community.slack.com](https://netdev.chat/)
+
+## Credits
+
+Based on the NetBox plugin tutorial:
+
+- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
+- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.

netbox_rack_design-0.1.0/README.md

@@ -0,0 +1,129 @@
+# NetBox Rack Design
+
+NetBox plugin for Rack Design.
+
+
+* Free software: Apache-2.0
+* Documentation: https://ravenrs.github.io/netbox-rack-design/
+
+
+## Features
+
+The features the plugin provides should be listed here. For example:
+
+- Manage Rack Design resources through NetBox UI
+- Track and organize Rack Design data with custom fields and tags
+- REST API endpoints for programmatic access
+- GraphQL support for flexible data queries
+- Full change logging and journaling support
+- Integration with NetBox's permission system
+- Global search integration for finding Rack Design objects
+- Comprehensive filtering and table views
+
+## Screenshots
+
+<!-- Add screenshots or GIFs demonstrating your plugin's functionality here -->
+_Screenshots will be added as features are developed._
+
+## Compatibility
+
+This plugin targets **NetBox 4.4.x**.
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     4.4.x      |      0.1.0     |
+
+For more detailed compatibility information, see [COMPATIBILITY.md](COMPATIBILITY.md).
+
+## Dependencies
+
+This plugin requires:
+- NetBox 4.4.0 – 4.4.x
+- Python 3.10 – 3.12
+
+No additional Python packages are required beyond NetBox's core dependencies.
+
+## REST API
+
+This plugin provides a REST API endpoint for managing Rack Design resources:
+
+- `/api/plugins/netbox_rack_design/rack-designs/` - List and create Rackdesign objects
+
+
+## GraphQL
+
+This plugin provides GraphQL support for querying Rack Design resources through NetBox's GraphQL API.
+
+
+## Installing
+
+For adding to a NetBox Docker setup see
+[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+While this is still in development and not yet on pypi you can install with pip:
+
+```bash
+pip install git+https://github.com/ravenrs/netbox-rack-design
+```
+
+or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
+
+```bash
+git+https://github.com/ravenrs/netbox-rack-design
+```
+
+Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
+ or if you use netbox-docker, your `/configuration/plugins.py` file :
+
+```python
+PLUGINS = [
+    'netbox_rack_design'
+]
+
+PLUGINS_CONFIG = {
+    "netbox_rack_design": {},
+}
+```
+
+## Configuration
+
+This plugin does not require any additional configuration by default. Optional configuration parameters can be added to `PLUGINS_CONFIG` in your NetBox configuration file as needed.
+
+## Usage
+
+For detailed usage instructions, please refer to the [documentation](https://ravenrs.github.io/netbox-rack-design/).
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+### Reporting Bugs
+
+Please report bugs by opening an issue on our [GitHub Issues](https://github.com/ravenrs/netbox-rack-design/issues) page. When reporting bugs, please include:
+
+- NetBox version
+- Plugin version
+- Python version
+- Steps to reproduce
+- Expected behavior
+- Actual behavior
+
+### Feature Requests
+
+Feature requests can be submitted as [GitHub Issues](https://github.com/ravenrs/netbox-rack-design/issues) with the "enhancement" label.
+
+## Support
+
+- **Documentation**: https://ravenrs.github.io/netbox-rack-design/
+- **Issues**: https://github.com/ravenrs/netbox-rack-design/issues
+- **Discussions**: https://github.com/ravenrs/netbox-rack-design/discussions
+- **NetBox Community Slack**: [netdev-community.slack.com](https://netdev.chat/)
+
+## Credits
+
+Based on the NetBox plugin tutorial:
+
+- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
+- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.

netbox_rack_design-0.1.0/netbox_rack_design/__init__.py

@@ -0,0 +1,44 @@
+"""
+NetBox Rack Design
+
+Plugin configuration for NetBox Rack Design.
+
+For a complete list of PluginConfig attributes, see:
+https://docs.netbox.dev/en/stable/plugins/development/#pluginconfig-attributes
+"""
+
+__author__ = """Petr Voronov"""
+__email__ = "ravenrs@gmail.com"
+__version__ = "0.1.0"
+
+
+from netbox.plugins import PluginConfig
+
+
+class RackdesignConfig(PluginConfig):
+    name = "netbox_rack_design"
+    verbose_name = "NetBox Rack Design"
+    description = "NetBox plugin for Rack Design."
+    author= "Petr Voronov"
+    author_email = "ravenrs@gmail.com"
+    version = __version__
+    base_url = "rack-design"
+    min_version = "4.4.0"
+    max_version = "4.4.99"
+    graphql_schema = "graphql.schema"
+    default_settings = {
+        # Device statuses the plugin treats as "planned".
+        "planned_statuses": ["planned"],
+        # Device statuses that mark a planned removal. Default uses native
+        # 'decommissioning'. Environments where that status is destructive
+        # (auto-delete / inventory dismantle) should override with a custom
+        # status added via FIELD_CHOICES (e.g. 'to_decommission').
+        "removal_statuses": ["decommissioning"],
+        # Default lifecycle status for a new Design.
+        "default_status": "draft",
+        # Show the rack-page panel listing designs that touch a rack.
+        "enable_rack_panel": True,
+    }
+
+
+config = RackdesignConfig

netbox_rack_design-0.1.0/netbox_rack_design/api/__init__.py

@@ -0,0 +1,6 @@
+"""
+REST API for NetBox Rack Design.
+
+For more information on developing NetBox REST APIs, see:
+https://docs.netbox.dev/en/stable/plugins/development/rest-api/
+"""

netbox_rack_design-0.1.0/netbox_rack_design/api/serializers.py

@@ -0,0 +1,52 @@
+"""REST API serializers for NetBox Rack Design."""
+
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+
+from ..models import Design, DesignGroup, DesignPlacement
+
+__all__ = ("DesignGroupSerializer", "DesignSerializer", "DesignPlacementSerializer")
+
+
+class DesignGroupSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_rack_design-api:designgroup-detail"
+    )
+
+    class Meta:
+        model = DesignGroup
+        fields = (
+            "id", "url", "display", "name", "parent", "description", "link",
+            "tags", "custom_fields", "created", "last_updated",
+        )
+        brief_fields = ("id", "url", "display", "name")
+
+
+class DesignSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_rack_design-api:design-detail"
+    )
+
+    class Meta:
+        model = Design
+        fields = (
+            "id", "url", "display", "title", "site", "status", "summary", "link",
+            "version", "root", "based_on", "sequence", "depends_on", "group",
+            "description", "comments", "tags", "custom_fields", "created", "last_updated",
+        )
+        brief_fields = ("id", "url", "display", "title", "version", "status")
+
+
+class DesignPlacementSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_rack_design-api:designplacement-detail"
+    )
+
+    class Meta:
+        model = DesignPlacement
+        fields = (
+            "id", "url", "display", "design", "kind", "device", "device_type",
+            "proposed_name", "target_rack", "target_position", "target_face",
+            "tags", "custom_fields", "created", "last_updated",
+        )
+        brief_fields = ("id", "url", "display", "kind")

netbox_rack_design-0.1.0/netbox_rack_design/api/urls.py

@@ -0,0 +1,14 @@
+"""REST API URL routing for NetBox Rack Design."""
+
+from netbox.api.routers import NetBoxRouter
+
+from .views import DesignGroupViewSet, DesignPlacementViewSet, DesignViewSet
+
+app_name = "netbox_rack_design"
+
+router = NetBoxRouter()
+router.register("design-groups", DesignGroupViewSet)
+router.register("designs", DesignViewSet)
+router.register("placements", DesignPlacementViewSet)
+
+urlpatterns = router.urls

netbox_rack_design-0.1.0/netbox_rack_design/api/views.py

@@ -0,0 +1,27 @@
+"""REST API viewsets for NetBox Rack Design."""
+
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from .. import filtersets
+from ..models import Design, DesignGroup, DesignPlacement
+from .serializers import DesignGroupSerializer, DesignPlacementSerializer, DesignSerializer
+
+__all__ = ("DesignGroupViewSet", "DesignViewSet", "DesignPlacementViewSet")
+
+
+class DesignGroupViewSet(NetBoxModelViewSet):
+    queryset = DesignGroup.objects.all()
+    serializer_class = DesignGroupSerializer
+    filterset_class = filtersets.DesignGroupFilterSet
+
+
+class DesignViewSet(NetBoxModelViewSet):
+    queryset = Design.objects.prefetch_related("placements", "depends_on", "tags")
+    serializer_class = DesignSerializer
+    filterset_class = filtersets.DesignFilterSet
+
+
+class DesignPlacementViewSet(NetBoxModelViewSet):
+    queryset = DesignPlacement.objects.all()
+    serializer_class = DesignPlacementSerializer
+    filterset_class = filtersets.DesignPlacementFilterSet

netbox_rack_design-0.1.0/netbox_rack_design/choices.py

@@ -0,0 +1,39 @@
+"""
+Choice sets for NetBox Rack Design.
+
+Uses NetBox's built-in ``ChoiceSet`` (utilities.choices), per the plugin
+development guide. Defining ``key`` lets administrators extend/replace these
+choices via ``FIELD_CHOICES`` in configuration.py.
+"""
+
+from utilities.choices import ChoiceSet
+
+
+class DesignStatusChoices(ChoiceSet):
+    key = "Design.status"
+
+    STATUS_DRAFT = "draft"
+    STATUS_APPROVED = "approved"
+    STATUS_REJECTED = "rejected"
+    STATUS_IMPLEMENTED = "implemented"
+    STATUS_SUPERSEDED = "superseded"
+
+    CHOICES = [
+        (STATUS_DRAFT, "Draft", "cyan"),
+        (STATUS_APPROVED, "Approved", "green"),
+        (STATUS_REJECTED, "Rejected", "red"),
+        (STATUS_IMPLEMENTED, "Implemented", "blue"),
+        (STATUS_SUPERSEDED, "Superseded", "gray"),
+    ]
+
+
+class DesignPlacementKindChoices(ChoiceSet):
+    KIND_ADD = "add"
+    KIND_MOVE = "move"
+    KIND_REMOVE = "remove"
+
+    CHOICES = [
+        (KIND_ADD, "Add", "green"),
+        (KIND_MOVE, "Move", "blue"),
+        (KIND_REMOVE, "Remove", "red"),
+    ]