netbox-sqids 0.1.1__tar.gz

netbox_sqids-0.1.1/LICENSE

@@ -0,0 +1,200 @@
+
+                                 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 the 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 any 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. Please also get an OpenPGP
+      key ID from a public key server, and include that with the notice.
+
+   Copyright 2026 Jonathan Senecal
+
+   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_sqids-0.1.1/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: netbox-sqids
+Version: 0.1.1
+Summary: NetBox plugin that adds short, URL-safe, globally unique SQID identifiers to every model
+Author-email: Jonathan Senecal <contact@jonathansenecal.com>
+Project-URL: Homepage, https://github.com/jsenecal/netbox-sqids
+Project-URL: Source, https://github.com/jsenecal/netbox-sqids
+Project-URL: Tracker, https://github.com/jsenecal/netbox-sqids/issues
+Project-URL: Documentation, https://jsenecal.github.io/netbox-sqids/
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqids>=0.4.1
+Provides-Extra: dev
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-django>=4.5.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: zensical; extra == "docs"
+Dynamic: license-file
+
+# NetBox SQIDs
+
+[![CI](https://github.com/jsenecal/netbox-sqids/actions/workflows/ci.yml/badge.svg)](https://github.com/jsenecal/netbox-sqids/actions/workflows/ci.yml)
+
+> **Alpha** — this plugin is functional but under active development. The API and SQID encoding may change before 1.0.
+
+Short, URL-safe, globally unique identifiers for every NetBox object.
+
+NetBox SQIDs adds a computed `sqid` property to every model in your NetBox instance. SQIDs encode the content type and primary key into a compact string that can be shared, bookmarked, and resolved back to the original object — no database changes required.
+
+## Quick Example
+
+```python
+>>> device = Device.objects.first()
+>>> device.sqid
+'WK1J'
+
+>>> from netbox_sqids.sqids import resolve_sqid
+>>> resolve_sqid('WK1J')
+<Device: my-switch>
+```
+
+Visit `/s/WK1J/` in your browser to be redirected to the device's detail page.
+
+## Features
+
+- **Zero-config** — install and every model gets a `.sqid` property
+- **No migrations** — pure computed properties, no database changes
+- **Globally unique** — SQIDs are unique across all models
+- **URL-safe** — curated 33-character alphabet, no ambiguous characters
+- **Redirect views** — resolve any SQID via browser or API
+- **Short URLs** — optional root-level routes like `/s/WK1J/`
+
+## Requirements
+
+| Dependency | Version  |
+|------------|----------|
+| NetBox     | >= 4.5.0 |
+| Python     | >= 3.12  |
+
+## Installation
+
+```bash
+pip install netbox-sqids
+```
+
+Add to your NetBox `configuration.py`:
+
+```python
+PLUGINS = ["netbox_sqids"]
+```
+
+Restart NetBox. That's it.
+
+## Configuration
+
+All settings are optional:
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_sqids": {
+        "min_length": 4,                      # Minimum SQID length (default: 4)
+        "blocklist": None,                    # Word blocklist (None = extended default)
+        "monkeypatched_url_prefix": "s",      # Short URL prefix (None to disable)
+    },
+}
+```
+
+## URL Routes
+
+| Route | Description |
+|-------|-------------|
+| `/plugins/sqids/<sqid>/` | Browser redirect to object |
+| `/api/plugins/sqids/<sqid>/` | API redirect to object |
+| `/s/<sqid>/` | Short browser redirect (configurable) |
+| `/api/s/<sqid>/` | Short API redirect (configurable) |
+
+## Documentation
+
+Full documentation: [jsenecal.github.io/netbox-sqids](https://jsenecal.github.io/netbox-sqids/)
+
+## License
+
+MIT

netbox_sqids-0.1.1/README.md

@@ -0,0 +1,84 @@
+# NetBox SQIDs
+
+[![CI](https://github.com/jsenecal/netbox-sqids/actions/workflows/ci.yml/badge.svg)](https://github.com/jsenecal/netbox-sqids/actions/workflows/ci.yml)
+
+> **Alpha** — this plugin is functional but under active development. The API and SQID encoding may change before 1.0.
+
+Short, URL-safe, globally unique identifiers for every NetBox object.
+
+NetBox SQIDs adds a computed `sqid` property to every model in your NetBox instance. SQIDs encode the content type and primary key into a compact string that can be shared, bookmarked, and resolved back to the original object — no database changes required.
+
+## Quick Example
+
+```python
+>>> device = Device.objects.first()
+>>> device.sqid
+'WK1J'
+
+>>> from netbox_sqids.sqids import resolve_sqid
+>>> resolve_sqid('WK1J')
+<Device: my-switch>
+```
+
+Visit `/s/WK1J/` in your browser to be redirected to the device's detail page.
+
+## Features
+
+- **Zero-config** — install and every model gets a `.sqid` property
+- **No migrations** — pure computed properties, no database changes
+- **Globally unique** — SQIDs are unique across all models
+- **URL-safe** — curated 33-character alphabet, no ambiguous characters
+- **Redirect views** — resolve any SQID via browser or API
+- **Short URLs** — optional root-level routes like `/s/WK1J/`
+
+## Requirements
+
+| Dependency | Version  |
+|------------|----------|
+| NetBox     | >= 4.5.0 |
+| Python     | >= 3.12  |
+
+## Installation
+
+```bash
+pip install netbox-sqids
+```
+
+Add to your NetBox `configuration.py`:
+
+```python
+PLUGINS = ["netbox_sqids"]
+```
+
+Restart NetBox. That's it.
+
+## Configuration
+
+All settings are optional:
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_sqids": {
+        "min_length": 4,                      # Minimum SQID length (default: 4)
+        "blocklist": None,                    # Word blocklist (None = extended default)
+        "monkeypatched_url_prefix": "s",      # Short URL prefix (None to disable)
+    },
+}
+```
+
+## URL Routes
+
+| Route | Description |
+|-------|-------------|
+| `/plugins/sqids/<sqid>/` | Browser redirect to object |
+| `/api/plugins/sqids/<sqid>/` | API redirect to object |
+| `/s/<sqid>/` | Short browser redirect (configurable) |
+| `/api/s/<sqid>/` | Short API redirect (configurable) |
+
+## Documentation
+
+Full documentation: [jsenecal.github.io/netbox-sqids](https://jsenecal.github.io/netbox-sqids/)
+
+## License
+
+MIT

netbox_sqids-0.1.1/netbox_sqids/__init__.py

@@ -0,0 +1,64 @@
+import logging
+
+from netbox.plugins import PluginConfig
+
+__version__ = "0.1.1"
+
+logger = logging.getLogger(__name__)
+
+
+class NetBoxSqidsConfig(PluginConfig):
+    name = "netbox_sqids"
+    verbose_name = "NetBox SQIDs"
+    description = "Short, URL-safe, globally unique identifiers for every NetBox object"
+    version = __version__
+    author = "Jonathan Senecal"
+    author_email = "contact@jonathansenecal.com"
+    base_url = "sqids"
+    default_settings = {
+        "min_length": 4,
+        "blocklist": None,
+        "monkeypatched_url_prefix": "s",
+    }
+
+    def ready(self):
+        super().ready()
+        self._patch_models()
+        self._patch_urls()
+
+    def _patch_models(self):
+        from django.apps import apps
+
+        from netbox_sqids.sqids import SqidDescriptor
+
+        for model in apps.get_models():
+            model.add_to_class("sqid", SqidDescriptor())
+
+    def _patch_urls(self):
+        from django.conf import settings
+
+        plugin_settings = settings.PLUGINS_CONFIG.get("netbox_sqids", {})
+        prefix = plugin_settings.get("monkeypatched_url_prefix", self.default_settings["monkeypatched_url_prefix"])
+        if prefix is None:
+            return
+
+        try:
+            import netbox.urls
+            from django.urls import path
+
+            from netbox_sqids.api.views import SqidApiRedirectView
+            from netbox_sqids.views import SqidRedirectView
+
+            netbox.urls.urlpatterns.append(
+                path(f"{prefix}/<str:sqid>/", SqidRedirectView.as_view(), name="sqid_short_redirect")
+            )
+            netbox.urls.urlpatterns.append(
+                path(f"api/{prefix}/<str:sqid>/", SqidApiRedirectView.as_view(), name="sqid_short_api_redirect")
+            )
+        except Exception:
+            logger.warning(
+                "Failed to monkey-patch short SQID URLs. The standard /plugins/sqids/ routes still work.", exc_info=True
+            )
+
+
+config = NetBoxSqidsConfig

netbox_sqids-0.1.1/netbox_sqids/api/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+
+from netbox_sqids.api.views import SqidApiRedirectView
+
+urlpatterns = [
+    path("<str:sqid>/", SqidApiRedirectView.as_view(), name="sqid_api_redirect"),
+]

netbox_sqids-0.1.1/netbox_sqids/api/views.py

@@ -0,0 +1,27 @@
+"""API redirect view for resolving SQIDs to REST API detail endpoints."""
+
+from django.core.exceptions import ObjectDoesNotExist
+from django.http import Http404, HttpResponseRedirect
+from django.urls import reverse
+from django.views import View
+from utilities.views import get_viewname
+
+from netbox_sqids.sqids import resolve_sqid
+
+
+class SqidApiRedirectView(View):
+    """Resolve a SQID and 302 redirect to the object's REST API detail endpoint."""
+
+    def get(self, request, sqid):
+        try:
+            obj = resolve_sqid(sqid)
+        except (ValueError, ObjectDoesNotExist) as exc:
+            raise Http404 from exc
+
+        try:
+            viewname = get_viewname(obj, action="detail", rest_api=True)
+            url = reverse(viewname, kwargs={"pk": obj.pk})
+        except (AttributeError, Exception) as exc:
+            raise Http404 from exc
+
+        return HttpResponseRedirect(url)

netbox_sqids-0.1.1/netbox_sqids/sqids.py

@@ -0,0 +1,83 @@
+"""SQID encoding, decoding, and descriptor for NetBox models.
+
+This module provides the core SQID logic: a factory for creating Sqids
+encoder instances, a Python descriptor for computed sqid properties,
+and a resolver function for decoding SQIDs back to model instances.
+"""
+
+from django.contrib.contenttypes.models import ContentType
+from sqids import Sqids
+
+ALPHABET = "0123456789ACDEFGHJKLMNPQRSTUVWXYZ"
+"""33-character alphabet excluding B, I, O to avoid visual ambiguity."""
+
+
+def get_sqids_instance(min_length: int = 4, blocklist: list[str] | None = None) -> Sqids:
+    """Create a configured Sqids encoder/decoder instance.
+
+    Args:
+        min_length: Minimum output string length.
+        blocklist: Words to filter from generated SQIDs. None uses the
+            extended default blocklist.
+
+    Returns:
+        A Sqids instance configured with the custom alphabet.
+    """
+    if blocklist is None:
+        from sqids.constants import DEFAULT_BLOCKLIST
+
+        blocklist = list(DEFAULT_BLOCKLIST) + ["ck", "sex", "butt"]
+    return Sqids(alphabet=ALPHABET, min_length=min_length, blocklist=blocklist)
+
+
+_sqids_instance = None
+
+
+def _get_instance() -> Sqids:
+    """Return the module-level Sqids singleton, creating it on first use."""
+    global _sqids_instance
+    if _sqids_instance is None:
+        from django.conf import settings
+
+        plugin_settings = settings.PLUGINS_CONFIG.get("netbox_sqids", {})
+        _sqids_instance = get_sqids_instance(
+            min_length=plugin_settings.get("min_length", 4),
+            blocklist=plugin_settings.get("blocklist", None),
+        )
+    return _sqids_instance
+
+
+class SqidDescriptor:
+    """Read-only descriptor that computes a SQID from an object's content type and PK.
+
+    Attached to models via ``add_to_class('sqid', SqidDescriptor())`` in
+    ``PluginConfig.ready()``. Returns None for unsaved objects and non-integer PKs.
+    """
+
+    def __get__(self, obj, objtype=None):
+        if obj is None:
+            return self
+        if obj.pk is None:
+            return None
+        if not isinstance(obj.pk, int):
+            return None
+        ct_id = ContentType.objects.get_for_model(obj).pk
+        return _get_instance().encode([ct_id, obj.pk])
+
+    def __set__(self, obj, value):
+        raise AttributeError("sqid is read-only")
+
+
+def resolve_sqid(sqid_str: str):
+    """Decode a SQID string and return the corresponding model instance.
+
+    Raises:
+        ValueError: if sqid_str is empty or decodes to unexpected length
+        ObjectDoesNotExist: if the content type or object doesn't exist
+    """
+    ids = _get_instance().decode(sqid_str)
+    if len(ids) != 2:
+        raise ValueError(f"Invalid SQID: {sqid_str}")
+    ct_id, obj_id = ids
+    ct = ContentType.objects.get_for_id(ct_id)
+    return ct.get_object_for_this_type(pk=obj_id)

netbox_sqids-0.1.1/netbox_sqids/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+
+from netbox_sqids.views import SqidRedirectView
+
+urlpatterns = [
+    path("<str:sqid>/", SqidRedirectView.as_view(), name="sqid_redirect"),
+]

netbox_sqids-0.1.1/netbox_sqids/views.py

@@ -0,0 +1,22 @@
+"""Browser redirect view for resolving SQIDs to object detail pages."""
+
+from django.core.exceptions import ObjectDoesNotExist
+from django.http import Http404, HttpResponseRedirect
+from django.views import View
+
+from netbox_sqids.sqids import resolve_sqid
+
+
+class SqidRedirectView(View):
+    """Resolve a SQID and 302 redirect to the object's ``get_absolute_url()``."""
+
+    def get(self, request, sqid):
+        try:
+            obj = resolve_sqid(sqid)
+        except (ValueError, ObjectDoesNotExist) as exc:
+            raise Http404 from exc
+
+        if not hasattr(obj, "get_absolute_url"):
+            raise Http404
+
+        return HttpResponseRedirect(obj.get_absolute_url())

netbox_sqids-0.1.1/netbox_sqids.egg-info/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: netbox-sqids
+Version: 0.1.1
+Summary: NetBox plugin that adds short, URL-safe, globally unique SQID identifiers to every model
+Author-email: Jonathan Senecal <contact@jonathansenecal.com>
+Project-URL: Homepage, https://github.com/jsenecal/netbox-sqids
+Project-URL: Source, https://github.com/jsenecal/netbox-sqids
+Project-URL: Tracker, https://github.com/jsenecal/netbox-sqids/issues
+Project-URL: Documentation, https://jsenecal.github.io/netbox-sqids/
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqids>=0.4.1
+Provides-Extra: dev
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-django>=4.5.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: zensical; extra == "docs"
+Dynamic: license-file
+
+# NetBox SQIDs
+
+[![CI](https://github.com/jsenecal/netbox-sqids/actions/workflows/ci.yml/badge.svg)](https://github.com/jsenecal/netbox-sqids/actions/workflows/ci.yml)
+
+> **Alpha** — this plugin is functional but under active development. The API and SQID encoding may change before 1.0.
+
+Short, URL-safe, globally unique identifiers for every NetBox object.
+
+NetBox SQIDs adds a computed `sqid` property to every model in your NetBox instance. SQIDs encode the content type and primary key into a compact string that can be shared, bookmarked, and resolved back to the original object — no database changes required.
+
+## Quick Example
+
+```python
+>>> device = Device.objects.first()
+>>> device.sqid
+'WK1J'
+
+>>> from netbox_sqids.sqids import resolve_sqid
+>>> resolve_sqid('WK1J')
+<Device: my-switch>
+```
+
+Visit `/s/WK1J/` in your browser to be redirected to the device's detail page.
+
+## Features
+
+- **Zero-config** — install and every model gets a `.sqid` property
+- **No migrations** — pure computed properties, no database changes
+- **Globally unique** — SQIDs are unique across all models
+- **URL-safe** — curated 33-character alphabet, no ambiguous characters
+- **Redirect views** — resolve any SQID via browser or API
+- **Short URLs** — optional root-level routes like `/s/WK1J/`
+
+## Requirements
+
+| Dependency | Version  |
+|------------|----------|
+| NetBox     | >= 4.5.0 |
+| Python     | >= 3.12  |
+
+## Installation
+
+```bash
+pip install netbox-sqids
+```
+
+Add to your NetBox `configuration.py`:
+
+```python
+PLUGINS = ["netbox_sqids"]
+```
+
+Restart NetBox. That's it.
+
+## Configuration
+
+All settings are optional:
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_sqids": {
+        "min_length": 4,                      # Minimum SQID length (default: 4)
+        "blocklist": None,                    # Word blocklist (None = extended default)
+        "monkeypatched_url_prefix": "s",      # Short URL prefix (None to disable)
+    },
+}
+```
+
+## URL Routes
+
+| Route | Description |
+|-------|-------------|
+| `/plugins/sqids/<sqid>/` | Browser redirect to object |
+| `/api/plugins/sqids/<sqid>/` | API redirect to object |
+| `/s/<sqid>/` | Short browser redirect (configurable) |
+| `/api/s/<sqid>/` | Short API redirect (configurable) |
+
+## Documentation
+
+Full documentation: [jsenecal.github.io/netbox-sqids](https://jsenecal.github.io/netbox-sqids/)
+
+## License
+
+MIT

netbox_sqids-0.1.1/netbox_sqids.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pyproject.toml
+netbox_sqids/__init__.py
+netbox_sqids/sqids.py
+netbox_sqids/urls.py
+netbox_sqids/views.py
+netbox_sqids.egg-info/PKG-INFO
+netbox_sqids.egg-info/SOURCES.txt
+netbox_sqids.egg-info/dependency_links.txt
+netbox_sqids.egg-info/requires.txt
+netbox_sqids.egg-info/top_level.txt
+netbox_sqids/api/__init__.py
+netbox_sqids/api/urls.py
+netbox_sqids/api/views.py
+tests/test_sqids.py
+tests/test_views.py

netbox_sqids-0.1.1/netbox_sqids.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

netbox_sqids-0.1.1/netbox_sqids.egg-info/requires.txt

@@ -0,0 +1,12 @@
+sqids>=0.4.1
+
+[dev]
+bumpver
+pre-commit>=4.0.0
+pytest
+pytest-django>=4.5.0
+pytest-cov>=3.0.0
+ruff
+
+[docs]
+zensical

netbox_sqids-0.1.1/netbox_sqids.egg-info/top_level.txt

@@ -0,0 +1 @@
+netbox_sqids

netbox_sqids-0.1.1/pyproject.toml

@@ -0,0 +1,97 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["netbox_sqids", "netbox_sqids.*"]
+
+[project]
+name = "netbox-sqids"
+version = "0.1.1"
+description = "NetBox plugin that adds short, URL-safe, globally unique SQID identifiers to every model"
+readme = "README.md"
+authors = [
+    { name = "Jonathan Senecal", email = "contact@jonathansenecal.com" },
+]
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+
+dependencies = [
+    "sqids>=0.4.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "bumpver",
+    "pre-commit>=4.0.0",
+    "pytest",
+    "pytest-django>=4.5.0",
+    "pytest-cov>=3.0.0",
+    "ruff",
+]
+docs = [
+    "zensical",
+]
+
+[project.urls]
+Homepage = "https://github.com/jsenecal/netbox-sqids"
+Source = "https://github.com/jsenecal/netbox-sqids"
+Tracker = "https://github.com/jsenecal/netbox-sqids/issues"
+Documentation = "https://jsenecal.github.io/netbox-sqids/"
+
+[tool.bumpver]
+current_version = "0.1.1"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit_message = "chore: bump version {old_version} -> {new_version}"
+tag_pattern = "vMAJOR.MINOR.PATCH"
+commit = true
+tag = true
+push = true
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = [
+    'current_version = "{version}"',
+    'version = "{version}"',
+]
+"netbox_sqids/__init__.py" = [
+    '__version__ = "{version}"',
+]
+"CHANGELOG.md" = [
+    '## \[Unreleased\]',
+    '## \[{version}\] - {now:%Y-%m-%d}',
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py312"
+extend-exclude = ["**/migrations/*.py"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "S", "B", "A", "C4", "DJ", "PIE"]
+ignore = ["E501", "N806", "S101", "DJ01"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101", "S105", "S106", "E402", "F841"]
+"migrations/*" = ["N806", "N999"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "netbox.settings"
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --cov=netbox_sqids --cov-report=term-missing --reuse-db"

netbox_sqids-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

netbox_sqids-0.1.1/tests/test_sqids.py

@@ -0,0 +1,132 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+from django.core.exceptions import ObjectDoesNotExist
+
+from netbox_sqids.sqids import SqidDescriptor, get_sqids_instance, resolve_sqid
+
+ALPHABET = "0123456789ACDEFGHJKLMNPQRSTUVWXYZ"
+
+
+class TestSqidsInstance:
+    def test_encodes_two_integers(self):
+        instance = get_sqids_instance(min_length=4, blocklist=[])
+        result = instance.encode([1, 1])
+        assert isinstance(result, str)
+        assert len(result) >= 4
+
+    def test_roundtrip(self):
+        instance = get_sqids_instance(min_length=4, blocklist=[])
+        encoded = instance.encode([42, 100])
+        decoded = instance.decode(encoded)
+        assert decoded == [42, 100]
+
+    def test_uses_custom_alphabet(self):
+        instance = get_sqids_instance(min_length=4, blocklist=[])
+        encoded = instance.encode([1, 1])
+        for char in encoded:
+            assert char in ALPHABET
+
+    def test_min_length_respected(self):
+        instance = get_sqids_instance(min_length=8, blocklist=[])
+        encoded = instance.encode([1, 1])
+        assert len(encoded) >= 8
+
+    def test_blocklist_filters_words(self):
+        instance = get_sqids_instance(min_length=1, blocklist=["sex"])
+        encoded = instance.encode([1, 1])
+        assert "sex" not in encoded.lower()
+
+
+class TestSqidDescriptor:
+    def test_class_access_returns_descriptor(self):
+        class FakeModel:
+            sqid = SqidDescriptor()
+
+        assert isinstance(FakeModel.sqid, SqidDescriptor)
+
+    def test_unsaved_object_returns_none(self):
+        class FakeModel:
+            pk = None
+            sqid = SqidDescriptor()
+
+        obj = FakeModel()
+        assert obj.sqid is None
+
+    @patch("netbox_sqids.sqids.ContentType")
+    def test_returns_encoded_sqid(self, mock_ct_class):
+        mock_ct = MagicMock()
+        mock_ct.pk = 5
+        mock_ct_class.objects.get_for_model.return_value = mock_ct
+
+        class FakeModel:
+            pk = 42
+            sqid = SqidDescriptor()
+
+        obj = FakeModel()
+
+        result = obj.sqid
+        assert isinstance(result, str)
+        assert len(result) >= 4
+
+        # Verify roundtrip
+        instance = get_sqids_instance()
+        decoded = instance.decode(result)
+        assert decoded == [5, 42]
+
+    @patch("netbox_sqids.sqids.ContentType")
+    def test_read_only(self, mock_ct_class):
+        class FakeModel:
+            pk = 1
+            sqid = SqidDescriptor()
+
+        obj = FakeModel()
+        with pytest.raises(AttributeError, match="read-only"):
+            obj.sqid = "something"
+
+    def test_non_integer_pk_returns_none(self):
+        class FakeModel:
+            pk = "uuid-string"
+            sqid = SqidDescriptor()
+
+        obj = FakeModel()
+        assert obj.sqid is None
+
+
+class TestResolveSqid:
+    def test_empty_string_raises_value_error(self):
+        with pytest.raises(ValueError, match="Invalid SQID"):
+            resolve_sqid("")
+
+    def test_invalid_sqid_raises_value_error(self):
+        # encode a single integer — should fail the len!=2 check
+        instance = get_sqids_instance()
+        bad_sqid = instance.encode([1])
+        with pytest.raises(ValueError, match="Invalid SQID"):
+            resolve_sqid(bad_sqid)
+
+    @patch("netbox_sqids.sqids.ContentType")
+    def test_resolves_valid_sqid(self, mock_ct_class):
+        instance = get_sqids_instance()
+        sqid_str = instance.encode([5, 42])
+
+        mock_obj = MagicMock()
+        mock_ct = MagicMock()
+        mock_ct_class.objects.get_for_id.return_value = mock_ct
+        mock_ct.get_object_for_this_type.return_value = mock_obj
+
+        result = resolve_sqid(sqid_str)
+
+        assert result is mock_obj
+        mock_ct_class.objects.get_for_id.assert_called_once_with(5)
+        mock_ct.get_object_for_this_type.assert_called_once_with(pk=42)
+
+    @patch("netbox_sqids.sqids.ContentType")
+    def test_nonexistent_content_type_raises(self, mock_ct_class):
+        instance = get_sqids_instance()
+        sqid_str = instance.encode([9999, 1])
+
+        mock_ct_class.objects.get_for_id.side_effect = ObjectDoesNotExist()
+
+        with pytest.raises(ObjectDoesNotExist):
+            resolve_sqid(sqid_str)

netbox_sqids-0.1.1/tests/test_views.py

@@ -0,0 +1,113 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+from django.test import RequestFactory
+
+from netbox_sqids.api.views import SqidApiRedirectView
+from netbox_sqids.views import SqidRedirectView
+
+
+class TestSqidRedirectView:
+    def setup_method(self):
+        self.factory = RequestFactory()
+
+    @patch("netbox_sqids.views.resolve_sqid")
+    def test_redirects_to_absolute_url(self, mock_resolve):
+        mock_obj = MagicMock()
+        mock_obj.get_absolute_url.return_value = "/dcim/devices/42/"
+        mock_resolve.return_value = mock_obj
+
+        request = self.factory.get("/plugins/sqids/ABCD/")
+        response = SqidRedirectView.as_view()(request, sqid="ABCD")
+
+        assert response.status_code == 302
+        assert response.url == "/dcim/devices/42/"
+
+    @patch("netbox_sqids.views.resolve_sqid")
+    def test_invalid_sqid_returns_404(self, mock_resolve):
+        from django.http import Http404
+
+        mock_resolve.side_effect = ValueError("Invalid SQID")
+
+        request = self.factory.get("/plugins/sqids/XXXX/")
+        with pytest.raises(Http404):
+            SqidRedirectView.as_view()(request, sqid="XXXX")
+
+    @patch("netbox_sqids.views.resolve_sqid")
+    def test_object_not_found_returns_404(self, mock_resolve):
+        from django.core.exceptions import ObjectDoesNotExist
+        from django.http import Http404
+
+        mock_resolve.side_effect = ObjectDoesNotExist()
+
+        request = self.factory.get("/plugins/sqids/ABCD/")
+        with pytest.raises(Http404):
+            SqidRedirectView.as_view()(request, sqid="ABCD")
+
+    @patch("netbox_sqids.views.resolve_sqid")
+    def test_no_get_absolute_url_returns_404(self, mock_resolve):
+        from django.http import Http404
+
+        mock_obj = MagicMock(spec=[])  # no get_absolute_url
+        mock_resolve.return_value = mock_obj
+
+        request = self.factory.get("/plugins/sqids/ABCD/")
+        with pytest.raises(Http404):
+            SqidRedirectView.as_view()(request, sqid="ABCD")
+
+
+class TestSqidApiRedirectView:
+    def setup_method(self):
+        self.factory = RequestFactory()
+
+    @patch("netbox_sqids.api.views.reverse")
+    @patch("netbox_sqids.api.views.get_viewname")
+    @patch("netbox_sqids.api.views.resolve_sqid")
+    def test_redirects_to_api_url(self, mock_resolve, mock_get_viewname, mock_reverse):
+        mock_obj = MagicMock()
+        mock_obj.pk = 42
+        mock_resolve.return_value = mock_obj
+        mock_get_viewname.return_value = "dcim-api:device-detail"
+        mock_reverse.return_value = "/api/dcim/devices/42/"
+
+        request = self.factory.get("/api/plugins/sqids/ABCD/")
+        response = SqidApiRedirectView.as_view()(request, sqid="ABCD")
+
+        assert response.status_code == 302
+        assert response.url == "/api/dcim/devices/42/"
+        mock_get_viewname.assert_called_once_with(mock_obj, action="detail", rest_api=True)
+        mock_reverse.assert_called_once_with("dcim-api:device-detail", kwargs={"pk": 42})
+
+    @patch("netbox_sqids.api.views.resolve_sqid")
+    def test_invalid_sqid_returns_404(self, mock_resolve):
+        from django.http import Http404
+
+        mock_resolve.side_effect = ValueError("Invalid SQID")
+
+        request = self.factory.get("/api/plugins/sqids/XXXX/")
+        with pytest.raises(Http404):
+            SqidApiRedirectView.as_view()(request, sqid="XXXX")
+
+    @patch("netbox_sqids.api.views.resolve_sqid")
+    def test_object_not_found_returns_404(self, mock_resolve):
+        from django.core.exceptions import ObjectDoesNotExist
+        from django.http import Http404
+
+        mock_resolve.side_effect = ObjectDoesNotExist()
+
+        request = self.factory.get("/api/plugins/sqids/ABCD/")
+        with pytest.raises(Http404):
+            SqidApiRedirectView.as_view()(request, sqid="ABCD")
+
+    @patch("netbox_sqids.api.views.get_viewname")
+    @patch("netbox_sqids.api.views.resolve_sqid")
+    def test_no_api_viewname_returns_404(self, mock_resolve, mock_get_viewname):
+        from django.http import Http404
+
+        mock_obj = MagicMock()
+        mock_resolve.return_value = mock_obj
+        mock_get_viewname.side_effect = AttributeError()
+
+        request = self.factory.get("/api/plugins/sqids/ABCD/")
+        with pytest.raises(Http404):
+            SqidApiRedirectView.as_view()(request, sqid="ABCD")