cesnet-service-path-plugin 4.0.0__tar.gz

cesnet_service_path_plugin-4.0.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/Jan.Krupa/komora-service-path-plugin/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
+
+Cesnet ServicePath Plugin could always use more documentation, whether as part of the
+official Cesnet ServicePath Plugin 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/Jan.Krupa/komora-service-path-plugin/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 `komora-service-path-plugin` for local development.
+
+1. Fork the `komora-service-path-plugin` repo on GitHub.
+2. Clone your fork locally
+
+    ```
+    $ git clone git@github.com:your_name_here/komora-service-path-plugin.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.8, 3.9, 3.10 and 3.11. Check
+   https://github.com/Jan.Krupa/komora-service-path-plugin/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:

cesnet_service_path_plugin-4.0.0/LICENSE

@@ -0,0 +1 @@
+

cesnet_service_path_plugin-4.0.0/MANIFEST.in

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

cesnet_service_path_plugin-4.0.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.2
+Name: cesnet_service_path_plugin
+Version: 4.0.0
+Summary: Adds ability to create service path in the CESNET network.
+Author: Jan Krupa
+License: MIT
+License-File: LICENSE
+Dynamic: author
+Dynamic: license
+Dynamic: summary

cesnet_service_path_plugin-4.0.0/README.md

@@ -0,0 +1,167 @@
+# CESNET ServicePath Plugin for NetBox
+
+A NetBox plugin for managing service paths and segments in network infrastructure.
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+## Overview
+
+The CESNET ServicePath Plugin extends NetBox's capabilities by:
+- Managing service paths across your network
+- Creating and tracking service segments
+- Visualizing service routing
+
+## Compatibility Matrix
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     4.2        |      4.0.0     |
+|     3.7        |      0.1.0     |
+
+## Features
+
+- Service Path Management
+  - Define experimental, core, and customer service paths
+  - Track service path status and metadata
+  - Link multiple segments to create complete paths
+
+- Segment Management
+  - Track network segments between locations
+  - Monitor installation and termination dates
+  - Manage provider relationships and contracts
+  - Link circuits to segments
+  - Automatic status tracking based on dates
+
+## Data Model
+
+### Service Path
+- Name and status tracking
+- Service type classification (experimental/core/customer)
+- Multiple segment support through mappings
+
+### Segment
+- Provider and location tracking
+- Date-based lifecycle management
+- Circuit associations
+- Automated status monitoring
+
+## Quick Start
+
+1. Install the plugin:
+```bash
+pip install cesnet_service_path_plugin
+```
+
+2. Enable the plugin in your NetBox configuration:
+```python
+PLUGINS = [
+    'cesnet_service_path_plugin'
+]
+
+PLUGINS_CONFIG = {
+    "cesnet_service_path_plugin": {},
+}
+```
+
+3. Run NetBox migrations:
+```bash
+python manage.py migrate
+```
+
+## Installation
+
+### Using pip
+```bash
+pip install git+https://gitlab.cesnet.cz/701/netbox/cesnet_service_path_plugin.git
+```
+
+### Using Docker
+For NetBox Docker installations, add to your `plugin_requirements.txt`:
+```bash
+cesnet_service_path_plugin
+```
+
+For detailed Docker setup instructions, see [using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+## Configuration
+
+### Custom Status Choices
+
+Extend or override default status choices in your `configuration.py`:
+
+```python
+FIELD_CHOICES = {
+    'cesnet_service_path_plugin.choices.status': (
+        ('custom_status', 'Custom Status', 'blue'),
+        # ('status_value', 'Display Name', 'color'),
+    )
+}
+```
+
+Status choice format:
+- Value: Internal database value
+- Name: UI display name
+- Color: Badge color (blue, green, red, orange, yellow, purple, gray)
+
+Default statuses (Active, Planned, Offline) will be merged with custom choices.
+
+### Custom Kind Choices
+
+Extend or override default kind choices in your `configuration.py`:
+
+```python
+FIELD_CHOICES = {
+    'cesnet_service_path_plugin.choices.kind': (
+        ('custom_kind', 'Custom Kind Name', 'purple'),
+        # ('kind_value', 'Display Name', 'color'),
+    )
+}
+```
+
+Kind choice format:
+- Value: Internal database value
+- Name: UI display name
+- Color: Badge color (blue, green, red, orange, yellow, purple, gray)
+
+Default kinds:
+- experimental: Experimentální (cyan)
+- core: Páteřní (blue)
+- customer: Zákaznická (green)
+
+Custom kinds will be merged with the default choices.
+
+## API Usage
+
+The plugin provides a REST API for managing service paths and segments:
+
+## Development
+
+### Setting Up Development Environment
+
+1. Clone the repository:
+```bash
+git clone https://gitlab.cesnet.cz/701/netbox/cesnet_service_path_plugin.git
+cd cesnet_service_path_plugin
+```
+
+2. Create a virtual environment:
+```bash
+python -m venv venv
+source venv/bin/activate  # Linux/Mac
+# or
+.\venv\Scripts\activate  # Windows
+```
+
+3. Install development dependencies:
+```bash
+pip install -e ".[dev]"
+```
+
+## Credits
+
+- Created using [Cookiecutter](https://github.com/audreyr/cookiecutter) and [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin)
+- Based on the [NetBox plugin tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/__init__.py

@@ -0,0 +1,15 @@
+"""Top-level package for Cesnet ServicePath Plugin."""
+
+from netbox.plugins import PluginConfig
+from .version import __version__, __author__, __email__, __description__, __name__
+
+
+class CesnetServicePathPluginConfig(PluginConfig):
+    name = __name__
+    verbose_name = "Cesnet ServicePath Plugin"
+    description = __description__
+    version = __version__
+    base_url = "cesnet-service-path-plugin"
+
+
+config = CesnetServicePathPluginConfig

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/serializers/__init__.py

@@ -0,0 +1,4 @@
+from .segment import *
+from .segment_circuit_mapping import *
+from .service_path import *
+from .service_path_segment_mapping import *

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/serializers/segment.py

@@ -0,0 +1,57 @@
+from circuits.api.serializers import CircuitSerializer, ProviderSerializer
+from dcim.api.serializers import (
+    LocationSerializer,
+    SiteSerializer,
+)
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+
+from cesnet_service_path_plugin.models.segment import Segment
+
+
+class SegmentSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:cesnet_service_path_plugin-api:segment-detail"
+    )
+    provider = ProviderSerializer(required=True, nested=True)
+    site_a = SiteSerializer(required=True, nested=True)
+    location_a = LocationSerializer(required=True, nested=True)
+    site_b = SiteSerializer(required=True, nested=True)
+    location_b = LocationSerializer(required=True, nested=True)
+    circuits = CircuitSerializer(required=False, many=True, nested=True)
+
+    class Meta:
+        model = Segment
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "status",
+            "network_label",
+            "install_date",
+            "termination_date",
+            "provider",
+            "provider_segment_id",
+            "provider_segment_name",
+            "provider_segment_contract",
+            "site_a",
+            "location_a",
+            "site_b",
+            "location_b",
+            "circuits",
+            "tags",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "status",
+            "tags",
+        )
+
+    def validate(self, data):
+        # Enforce model validation
+        super().validate(data)
+        return data

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/serializers/segment_circuit_mapping.py

@@ -0,0 +1,34 @@
+from rest_framework import serializers
+from netbox.api.serializers import NetBoxModelSerializer
+from cesnet_service_path_plugin.api.serializers.segment import SegmentSerializer
+from cesnet_service_path_plugin.api.serializers.service_path import ServicePathSerializer
+from cesnet_service_path_plugin.models import SegmentCircuitMapping
+from circuits.api.serializers import CircuitSerializer
+
+class SegmentCircuitMappingSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:cesnet_service_path_plugin-api:segmentcircuitmapping-detail"
+    )
+    circuit = CircuitSerializer(nested=True)
+    segment = SegmentSerializer(nested=True)
+
+    class Meta:
+        model = SegmentCircuitMapping
+        fields = [
+            "id",
+            "url",
+            "display",
+            "segment",
+            "circuit",
+        ]
+        brief_fields = [
+            "id",
+            "url",
+            "display",
+            "segment",
+            "circuit",
+        ]
+
+    def validate(self, data):
+        super().validate(data)
+        return data

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/serializers/service_path.py

@@ -0,0 +1,39 @@
+from circuits.api.serializers import CircuitSerializer
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+
+from cesnet_service_path_plugin.api.serializers.segment import SegmentSerializer
+from cesnet_service_path_plugin.models import ServicePath
+
+
+class ServicePathSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:cesnet_service_path_plugin-api:servicepath-detail"
+    )
+    segments = SegmentSerializer(many=True, read_only=True, nested=True)
+    circuits = CircuitSerializer(required=False, many=True, nested=True)
+
+    class Meta:
+        model = ServicePath
+        fields = [
+            "id",
+            "url",
+            "display",
+            "name",
+            "status",
+            "kind",
+            "segments",
+            "circuits",
+            "tags",
+        ]
+        brief_fields = [
+            "id",
+            "url",
+            "display",
+            "name",
+            "tags",
+        ]
+
+    def validate(self, data):
+        super().validate(data)
+        return data

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/serializers/service_path_segment_mapping.py

@@ -0,0 +1,40 @@
+from rest_framework import serializers
+from netbox.api.serializers import NetBoxModelSerializer
+from cesnet_service_path_plugin.api.serializers.segment import SegmentSerializer
+from cesnet_service_path_plugin.api.serializers.service_path import (
+    ServicePathSerializer,
+)
+from cesnet_service_path_plugin.models import ServicePathSegmentMapping
+
+
+class ServicePathSegmentMappingSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:cesnet_service_path_plugin-api:servicepathsegmentmapping-detail"
+    )
+    # service_path = serializers.PrimaryKeyRelatedField(
+    #    queryset=ServicePath.objects.all(),
+    #    required=True
+    # )
+    service_path = ServicePathSerializer(nested=True)
+    segment = SegmentSerializer(nested=True)
+
+    class Meta:
+        model = ServicePathSegmentMapping
+        fields = [
+            "id",
+            "url",
+            "display",
+            "service_path",
+            "segment",
+        ]
+        brief_fields = [
+            "id",
+            "url",
+            "display",
+            "service_path",
+            "segment",
+        ]
+
+    def validate(self, data):
+        super().validate(data)
+        return data

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/urls.py

@@ -0,0 +1,12 @@
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+app_name = "cesnet_service_path_plugin"
+router = NetBoxRouter()
+router.register("segments", views.SegmentViewSet)
+router.register("service-paths", views.ServicePathViewSet)
+router.register("service-path-segment-mappings", views.ServicePathSegmentMappingViewSet)
+router.register("segment-circuit-mappings", views.SegmnetCircuitMappingViewSet)
+
+urlpatterns = router.urls

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/views/__init__.py

@@ -0,0 +1,4 @@
+from .segment import *
+from .segment_circuit_mapping import *
+from .service_path import *
+from .service_path_segment_mapping import *

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/views/segment.py

@@ -0,0 +1,13 @@
+from netbox.api.metadata import ContentTypeMetadata
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from cesnet_service_path_plugin.models import Segment
+from cesnet_service_path_plugin.filtersets import SegmentFilterSet
+from cesnet_service_path_plugin.api.serializers import SegmentSerializer
+
+
+class SegmentViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = Segment.objects.all()
+    serializer_class = SegmentSerializer
+    filterset_class = SegmentFilterSet

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/views/segment_circuit_mapping.py

@@ -0,0 +1,12 @@
+from netbox.api.metadata import ContentTypeMetadata
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from cesnet_service_path_plugin import filtersets, models
+from cesnet_service_path_plugin.api.serializers import SegmentCircuitMappingSerializer
+
+
+class SegmnetCircuitMappingViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = models.SegmentCircuitMapping.objects.all()
+    serializer_class = SegmentCircuitMappingSerializer
+    filterset_class = filtersets.SegmentCircuitMappingFilterSet

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/views/service_path.py

@@ -0,0 +1,12 @@
+from netbox.api.metadata import ContentTypeMetadata
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from ... import filtersets, models
+from ..serializers import ServicePathSerializer
+
+
+class ServicePathViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = models.ServicePath.objects.all()
+    serializer_class = ServicePathSerializer
+    filterset_class = filtersets.ServicePathFilterSet

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/api/views/service_path_segment_mapping.py

@@ -0,0 +1,12 @@
+from netbox.api.metadata import ContentTypeMetadata
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from cesnet_service_path_plugin import filtersets, models
+from cesnet_service_path_plugin.api.serializers import ServicePathSegmentMappingSerializer
+
+
+class ServicePathSegmentMappingViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = models.ServicePathSegmentMapping.objects.all()
+    serializer_class = ServicePathSegmentMappingSerializer
+    filterset_class = filtersets.ServicePathSegmentMappingFilterSet

cesnet_service_path_plugin-4.0.0/cesnet_service_path_plugin/filtersets/__init__.py

@@ -0,0 +1,4 @@
+from .segment import *
+from .segment_circuit_mapping import *
+from .service_path import *
+from .service_path_segment_mapping import *