netbox-plugin-catalog 0.1.1__tar.gz

netbox_plugin_catalog-0.1.1/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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
+
+   Copyright 2026 sieteunoseis
+
+   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_plugin_catalog-0.1.1/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: netbox-plugin-catalog
+Version: 0.1.1
+Summary: A NetBox plugin for browsing and installing third-party plugins
+Author-email: sieteunoseis <sieteunoseis@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/sieteunoseis/netbox-plugin-catalog
+Project-URL: Repository, https://github.com/sieteunoseis/netbox-plugin-catalog
+Project-URL: Documentation, https://github.com/sieteunoseis/netbox-plugin-catalog/wiki
+Project-URL: Issues, https://github.com/sieteunoseis/netbox-plugin-catalog/issues
+Keywords: netbox,plugin,catalog,marketplace
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: packaging>=21.0
+Dynamic: license-file
+
+# NetBox Plugin Catalog
+
+A NetBox plugin that provides an in-app catalog for browsing and installing third-party NetBox plugins.
+
+![NetBox Version](https://img.shields.io/badge/NetBox-4.0+-blue)
+![Python Version](https://img.shields.io/badge/Python-3.10+-green)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![CI](https://github.com/sieteunoseis/netbox-plugin-catalog/actions/workflows/ci.yml/badge.svg)](https://github.com/sieteunoseis/netbox-plugin-catalog/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/netbox-plugin-catalog)](https://pypi.org/project/netbox-plugin-catalog/)
+
+## Features
+
+- **Browse Plugins**: Discover NetBox plugins from PyPI with rich metadata
+- **Curated Catalog**: Quality ratings, categories, and compatibility information
+- **One-Click Install**: Install plugins directly from the NetBox UI via pip
+- **Compatibility Checking**: Verify plugin compatibility with your NetBox version
+- **Installation History**: Track all plugin installation attempts
+- **Smart Detection**: Auto-detect installed and activated plugins
+
+## Requirements
+
+- NetBox 4.0.0 or higher
+- Python 3.10 or higher
+
+## Installation
+
+### Via pip
+
+```bash
+pip install netbox-plugin-catalog
+```
+
+### Via source
+
+```bash
+git clone https://github.com/sieteunoseis/netbox-plugin-catalog.git
+cd netbox-plugin-catalog
+pip install .
+```
+
+## Configuration
+
+Add the plugin to your `configuration.py`:
+
+```python
+PLUGINS = [
+    'netbox_catalog',
+]
+
+PLUGINS_CONFIG = {
+    'netbox_catalog': {
+        'pypi_cache_timeout': 3600,        # Cache PyPI data for 1 hour
+        'catalog_json_url': '',            # Optional: remote catalog.json URL
+        'allow_install': True,             # Enable/disable pip install feature
+        'show_uncurated': True,            # Show plugins not in curated list
+        'pypi_index_url': 'https://pypi.org',  # PyPI mirror support
+    }
+}
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate
+```
+
+Collect static files:
+
+```bash
+python manage.py collectstatic --no-input
+```
+
+Restart NetBox.
+
+## Usage
+
+### Browsing Plugins
+
+Navigate to **Plugins > Plugin Catalog > Browse Plugins** to view all available NetBox plugins.
+
+You can filter by:
+- **Search**: Filter by name, summary, or author
+- **Category**: Network Management, Security, Automation, etc.
+- **Certification**: Certified, Compatible, Untested, Deprecated
+- **Status**: Installed, Not Installed, Activated, Upgrade Available
+- **Compatibility**: Compatible, Incompatible, Unknown
+
+### Installing Plugins
+
+1. Click on a plugin to view details
+2. Click **Install** (or **Upgrade** if already installed)
+3. Confirm the installation
+4. Follow the post-installation instructions:
+   - Add the plugin to `PLUGINS` in `configuration.py`
+   - Run `python manage.py migrate`
+   - Run `python manage.py collectstatic`
+   - Restart NetBox
+
+### Compatibility Detection
+
+The plugin checks compatibility through multiple sources:
+
+1. **Curated catalog**: Manually verified compatibility info in `catalog.json`
+2. **PluginConfig**: After pip install, reads `min_version`/`max_version` from plugin
+3. **README parsing**: Attempts to extract version info from description (fallback)
+
+Compatibility status is shown with clear indicators:
+- **Compatible**: Plugin works with your NetBox version
+- **Unknown**: No compatibility information available
+- **Incompatible**: Plugin requires a different NetBox version
+
+## Curated Catalog
+
+The `catalog.json` file provides curated metadata for plugins:
+
+```json
+{
+    "plugins": {
+        "netbox-bgp": {
+            "category": "Network Management",
+            "tags": ["routing", "bgp"],
+            "certification": "certified",
+            "netbox_min_version": "4.0.0",
+            "notes": "Official BGP plugin",
+            "recommended": true,
+            "featured": true
+        }
+    }
+}
+```
+
+### Updating the Catalog
+
+You can host your own catalog JSON and configure it:
+
+```python
+PLUGINS_CONFIG = {
+    'netbox_catalog': {
+        'catalog_json_url': 'https://example.com/netbox-plugins.json',
+    }
+}
+```
+
+## Security Considerations
+
+- **Permissions**: Only users with `netbox_catalog.add_installationlog` permission can install plugins
+- **pip install**: Runs in the same Python environment as NetBox
+- **Network access**: Requires outbound HTTPS to pypi.org
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
+
+### Adding Plugins to Curated Catalog
+
+To add a plugin to the curated catalog, submit a PR updating `catalog.json` with:
+
+- `category`: One of the predefined categories
+- `tags`: Relevant keywords
+- `certification`: certified, compatible, untested, or deprecated
+- `netbox_min_version`: Minimum supported NetBox version
+- `notes`: Brief description or compatibility notes
+- `recommended`: Whether the plugin is recommended
+- `featured`: Whether to show in featured section
+
+## License
+
+Apache License 2.0
+
+## Acknowledgments
+
+- [NetBox](https://github.com/netbox-community/netbox) - The leading network source of truth
+- [NetBox Labs](https://netboxlabs.com/plugins/) - Plugin catalog inspiration
+- All the NetBox plugin developers

netbox_plugin_catalog-0.1.1/README.md

@@ -0,0 +1,174 @@
+# NetBox Plugin Catalog
+
+A NetBox plugin that provides an in-app catalog for browsing and installing third-party NetBox plugins.
+
+![NetBox Version](https://img.shields.io/badge/NetBox-4.0+-blue)
+![Python Version](https://img.shields.io/badge/Python-3.10+-green)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![CI](https://github.com/sieteunoseis/netbox-plugin-catalog/actions/workflows/ci.yml/badge.svg)](https://github.com/sieteunoseis/netbox-plugin-catalog/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/netbox-plugin-catalog)](https://pypi.org/project/netbox-plugin-catalog/)
+
+## Features
+
+- **Browse Plugins**: Discover NetBox plugins from PyPI with rich metadata
+- **Curated Catalog**: Quality ratings, categories, and compatibility information
+- **One-Click Install**: Install plugins directly from the NetBox UI via pip
+- **Compatibility Checking**: Verify plugin compatibility with your NetBox version
+- **Installation History**: Track all plugin installation attempts
+- **Smart Detection**: Auto-detect installed and activated plugins
+
+## Requirements
+
+- NetBox 4.0.0 or higher
+- Python 3.10 or higher
+
+## Installation
+
+### Via pip
+
+```bash
+pip install netbox-plugin-catalog
+```
+
+### Via source
+
+```bash
+git clone https://github.com/sieteunoseis/netbox-plugin-catalog.git
+cd netbox-plugin-catalog
+pip install .
+```
+
+## Configuration
+
+Add the plugin to your `configuration.py`:
+
+```python
+PLUGINS = [
+    'netbox_catalog',
+]
+
+PLUGINS_CONFIG = {
+    'netbox_catalog': {
+        'pypi_cache_timeout': 3600,        # Cache PyPI data for 1 hour
+        'catalog_json_url': '',            # Optional: remote catalog.json URL
+        'allow_install': True,             # Enable/disable pip install feature
+        'show_uncurated': True,            # Show plugins not in curated list
+        'pypi_index_url': 'https://pypi.org',  # PyPI mirror support
+    }
+}
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate
+```
+
+Collect static files:
+
+```bash
+python manage.py collectstatic --no-input
+```
+
+Restart NetBox.
+
+## Usage
+
+### Browsing Plugins
+
+Navigate to **Plugins > Plugin Catalog > Browse Plugins** to view all available NetBox plugins.
+
+You can filter by:
+- **Search**: Filter by name, summary, or author
+- **Category**: Network Management, Security, Automation, etc.
+- **Certification**: Certified, Compatible, Untested, Deprecated
+- **Status**: Installed, Not Installed, Activated, Upgrade Available
+- **Compatibility**: Compatible, Incompatible, Unknown
+
+### Installing Plugins
+
+1. Click on a plugin to view details
+2. Click **Install** (or **Upgrade** if already installed)
+3. Confirm the installation
+4. Follow the post-installation instructions:
+   - Add the plugin to `PLUGINS` in `configuration.py`
+   - Run `python manage.py migrate`
+   - Run `python manage.py collectstatic`
+   - Restart NetBox
+
+### Compatibility Detection
+
+The plugin checks compatibility through multiple sources:
+
+1. **Curated catalog**: Manually verified compatibility info in `catalog.json`
+2. **PluginConfig**: After pip install, reads `min_version`/`max_version` from plugin
+3. **README parsing**: Attempts to extract version info from description (fallback)
+
+Compatibility status is shown with clear indicators:
+- **Compatible**: Plugin works with your NetBox version
+- **Unknown**: No compatibility information available
+- **Incompatible**: Plugin requires a different NetBox version
+
+## Curated Catalog
+
+The `catalog.json` file provides curated metadata for plugins:
+
+```json
+{
+    "plugins": {
+        "netbox-bgp": {
+            "category": "Network Management",
+            "tags": ["routing", "bgp"],
+            "certification": "certified",
+            "netbox_min_version": "4.0.0",
+            "notes": "Official BGP plugin",
+            "recommended": true,
+            "featured": true
+        }
+    }
+}
+```
+
+### Updating the Catalog
+
+You can host your own catalog JSON and configure it:
+
+```python
+PLUGINS_CONFIG = {
+    'netbox_catalog': {
+        'catalog_json_url': 'https://example.com/netbox-plugins.json',
+    }
+}
+```
+
+## Security Considerations
+
+- **Permissions**: Only users with `netbox_catalog.add_installationlog` permission can install plugins
+- **pip install**: Runs in the same Python environment as NetBox
+- **Network access**: Requires outbound HTTPS to pypi.org
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
+
+### Adding Plugins to Curated Catalog
+
+To add a plugin to the curated catalog, submit a PR updating `catalog.json` with:
+
+- `category`: One of the predefined categories
+- `tags`: Relevant keywords
+- `certification`: certified, compatible, untested, or deprecated
+- `netbox_min_version`: Minimum supported NetBox version
+- `notes`: Brief description or compatibility notes
+- `recommended`: Whether the plugin is recommended
+- `featured`: Whether to show in featured section
+
+## License
+
+Apache License 2.0
+
+## Acknowledgments
+
+- [NetBox](https://github.com/netbox-community/netbox) - The leading network source of truth
+- [NetBox Labs](https://netboxlabs.com/plugins/) - Plugin catalog inspiration
+- All the NetBox plugin developers

netbox_plugin_catalog-0.1.1/netbox_catalog/__init__.py

@@ -0,0 +1,25 @@
+from netbox.plugins import PluginConfig
+
+__version__ = "0.1.1"
+
+
+class NetBoxCatalogConfig(PluginConfig):
+    name = "netbox_catalog"
+    verbose_name = "Plugin Catalog"
+    description = "Browse and install third-party NetBox plugins"
+    version = __version__
+    author = "sieteunoseis"
+    author_email = "sieteunoseis@gmail.com"
+    base_url = "catalog"
+    min_version = "4.0.0"
+
+    default_settings = {
+        "pypi_cache_timeout": 3600,  # Cache PyPI data for 1 hour
+        "catalog_json_url": "",  # Optional: remote catalog.json URL
+        "allow_install": True,  # Enable/disable pip install feature
+        "show_uncurated": True,  # Show plugins not in curated list
+        "pypi_index_url": "https://pypi.org",  # PyPI mirror support
+    }
+
+
+config = NetBoxCatalogConfig

netbox_plugin_catalog-0.1.1/netbox_catalog/api/__init__.py

@@ -0,0 +1 @@
+# API module

netbox_plugin_catalog-0.1.1/netbox_catalog/api/serializers.py

@@ -0,0 +1,32 @@
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+
+from ..models import InstallationLog
+
+
+class InstallationLogSerializer(NetBoxModelSerializer):
+    """Serializer for InstallationLog model."""
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_catalog-api:installationlog-detail"
+    )
+
+    class Meta:
+        model = InstallationLog
+        fields = [
+            "id",
+            "url",
+            "display",
+            "package_name",
+            "version",
+            "action",
+            "status",
+            "output",
+            "error",
+            "user",
+            "started",
+            "completed",
+            "created",
+            "last_updated",
+        ]
+        read_only_fields = ["user", "started", "completed"]

netbox_plugin_catalog-0.1.1/netbox_catalog/api/urls.py

@@ -0,0 +1,8 @@
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+router = NetBoxRouter()
+router.register("installation-logs", views.InstallationLogViewSet)
+
+urlpatterns = router.urls

netbox_plugin_catalog-0.1.1/netbox_catalog/api/views.py

@@ -0,0 +1,13 @@
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from ..filtersets import InstallationLogFilterSet
+from ..models import InstallationLog
+from .serializers import InstallationLogSerializer
+
+
+class InstallationLogViewSet(NetBoxModelViewSet):
+    """API viewset for InstallationLog model."""
+
+    queryset = InstallationLog.objects.all()
+    serializer_class = InstallationLogSerializer
+    filterset_class = InstallationLogFilterSet