netbox-scope-switcher 0.1.0__tar.gz

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

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: netbox-scope-switcher
+Version: 0.1.0
+Summary: Configurable multi-dimension scope selector in the NetBox navbar that scopes list views by tenant, site, region, tag, and more.
+Author-email: Du10777 <du103682@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Du10777/netbox-scope-switcher
+Project-URL: Repository, https://github.com/Du10777/netbox-scope-switcher
+Project-URL: Documentation, https://github.com/Du10777/netbox-scope-switcher#readme
+Project-URL: Issues, https://github.com/Du10777/netbox-scope-switcher/issues
+Project-URL: Changelog, https://github.com/Du10777/netbox-scope-switcher/blob/main/CHANGELOG.md
+Keywords: netbox,netbox-plugin,plugin,scope,tenant,site,region,tag,multitenancy,filter,dcim,ipam
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+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
+Dynamic: license-file
+
+# NetBox Scope Switcher
+
+**Pick your scope once — tenant, region, site, tag, whatever you configure — and
+every list in NetBox narrows to it, with the filters cascading on each other.**
+
+`netbox-scope-switcher` adds one compact, configurable selector to the top
+navigation bar. Choose values across any number of *scope dimensions* (grouped
+however you like) and, as you move between sections (Devices, Prefixes, VLANs,
+Sites, …), each list view is automatically scoped to your selection.
+
+It generalizes
+[`netbox-tenant-switcher`](https://github.com/Du10777/netbox-tenant-switcher):
+tenant is just the default dimension.
+
+## Screenshots
+
+![Grouped scope panel with a tenant selected; the Site list has cascaded to that tenant](docs/img/cascade.png)
+
+<p>
+  <img src="docs/img/panel.png" width="340" alt="Grouped dimensions: Tenant / Location / Tag">
+  <img src="docs/img/i18n.png" width="340" alt="Labels follow the NetBox UI language">
+</p>
+
+## Features
+
+- **Configurable, grouped dimensions.** Scope by tenant, tenant group, region,
+  site group, site, location, tag, or any filter you declare in `PLUGINS_CONFIG`
+  — arranged under your own group headings. No code changes.
+- **Cascading dependent filters.** Selecting values in one dimension narrows the
+  option lists of the others, in both directions: pick a *Tenant Group* and only
+  its tenants remain; pick a *Tenant* and Regions/Sites/Racks shrink to where that
+  tenant is present. Powered by NetBox's own filtersets (so tree descendants and
+  every relationship are honoured), with no hard-coded model knowledge.
+- **Token-style control.** One dropdown with a section per dimension: selected
+  values shown as removable chips, a `+ add` picker with instant search, an `Any`
+  placeholder, a `None` option (for objects with no value), per-dimension and
+  global *clear*. Chips stay name-sorted. No external JS dependencies.
+- **Localized.** Dimension labels come straight from each model's NetBox
+  `verbose_name`, and the service words are translated via NetBox's catalog, so
+  the panel follows the active UI language automatically.
+- **Resizable & viewport-bounded panel.** Drag the corner grip to resize (the
+  size is remembered for the session); the panel never grows past the screen and
+  scrolls internally.
+- **Honest URLs.** By default the plugin issues a single redirect that adds the
+  filter params to the address bar, so links are shareable, NetBox's own filter
+  panel shows them, and *Clear filters* behaves predictably. A `silent` mode is
+  available.
+- **Per-scope applicability.** Each dimension is applied only on list views whose
+  filterset actually supports it — a prefixes list may scope by tenant and tag but
+  not region — computed by introspection, not hard-coding. The control dims when
+  nothing applies to the current page.
+- **Combining semantics:** several values within a dimension are OR-combined;
+  different dimensions are AND-combined; `None` maps to `?param=null`.
+- **Permission-aware.** Only values the user may view are listed and selectable,
+  and scoping only ever *narrows* results — NetBox object permissions still apply
+  on top.
+- **No models, no migrations.** Selection lives in the session.
+
+## Compatibility
+
+| Plugin version | NetBox version | Python      |
+| -------------- | -------------- | ----------- |
+| 0.1.x          | 4.6            | 3.10 – 3.12 |
+
+Developed and verified against **NetBox 4.6**, using only stable plugin APIs
+(`PluginTemplateExtension.navbar()` / `head()`, plugin middleware). The CI matrix
+(`.github/workflows/ci.yml`) additionally exercises 4.4 and 4.5.
+
+## Installation
+
+```bash
+source /opt/netbox/venv/bin/activate
+pip install netbox-scope-switcher
+```
+
+Enable it in `configuration.py`:
+
+```python
+PLUGINS = ["netbox_scope_switcher"]
+```
+
+Restart NetBox (`sudo systemctl restart netbox netbox-rq`). No migrations needed.
+
+### Docker (netbox-docker)
+
+See [`deploy/`](deploy/) for a ready-to-use `Dockerfile-Plugins`,
+`docker-compose.override.yml`, and `plugins.py`.
+
+## Configuration
+
+Out of the box the plugin scopes by **tenant only** (matching
+`netbox-tenant-switcher`). To configure dimensions and grouping, set
+`PLUGINS_CONFIG`:
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_scope_switcher": {
+        "mode": "redirect",  # or "silent"
+        "scopes": [
+            {"param": "tenant_group_id", "model": "tenancy.TenantGroup", "group": "Tenant"},
+            {"param": "tenant_id",       "model": "tenancy.Tenant",      "group": "Tenant"},
+            {"param": "region_id",       "model": "dcim.Region",         "group": "Location"},
+            {"param": "site_group_id",   "model": "dcim.SiteGroup",      "group": "Location"},
+            {"param": "site_id",         "model": "dcim.Site",           "group": "Location"},
+            {"param": "location_id",     "model": "dcim.Location",       "group": "Location"},
+            {"param": "tag",             "model": "extras.Tag",          "group": "Tag",
+             "value_field": "slug"},
+        ],
+    }
+}
+```
+
+### `PLUGINS_CONFIG` keys
+
+| Key      | Type   | Default     | Description |
+| -------- | ------ | ----------- | ----------- |
+| `scopes` | list   | tenant only | Ordered list of scope dimensions (below). |
+| `mode`   | string | `redirect`  | `redirect` (add params to the URL via a 302) or `silent` (rewrite the request in place). |
+
+Each entry in `scopes`:
+
+| Field         | Required | Default            | Description |
+| ------------- | -------- | ------------------ | ----------- |
+| `param`       | yes      | —                  | GET parameter of the filter to apply (e.g. `tenant_id`, `tag`). |
+| `model`       | yes      | —                  | `app_label.ModelName` the dropdown values come from. |
+| `group`       | no       | —                  | Group heading to list this dimension under (translated via NetBox). |
+| `label`       | no       | model verbose name | Section heading. Omit it to follow the active UI language. |
+| `value_field` | no       | `pk`               | Value to put in the param: `pk` or `slug` (tags filter by slug). |
+
+The configuration is validated at startup: an unknown model or field raises a
+clear `ImproperlyConfigured` error on load, rather than a 500 at runtime.
+
+## How it works
+
+- **Navbar widget** (`template_content.py`) — a `PluginTemplateExtension` renders
+  the control + a section per dimension via `navbar()`; CSS/JS are injected once
+  via `head()`. Options are fetched from the values endpoint on open (so they can
+  cascade); only the static `None` option is server-rendered.
+- **Set endpoint** (`views.py`) — `GET /plugins/scope-switcher/set/` stores the
+  chosen values per dimension in the session and redirects back. `next` is
+  validated against the current host (no open redirects); every value is checked
+  against the user's view permission.
+- **Values endpoint** (`views.py`) —
+  `GET /plugins/scope-switcher/values/<param>/?q=…&<other>=…` returns a
+  permission-scoped, cascaded, searchable JSON option list.
+- **Cascade** (`cascade.py`) — narrows a dimension's options to those consistent
+  with the current selection in the others. A *forward* pass filters a model by
+  every other scope its own filterset supports (Site by Region, Rack by Location,
+  …); a *reverse* pass handles the "upward" direction by pivoting through a bridge
+  model that has a FK to the target and whose filterset does support the source
+  (Site bridges Region↔Tenant, Tenant bridges Tenant Group↔Tenant, …).
+- **Applicability** (`applicability.py`) — introspects the current list view's
+  filterset (`get_filters()` / `base_filters`) to decide which configured params
+  it supports; used to dim the control and to choose what to apply.
+- **Middleware** (`middleware.py`) — for `ObjectListView` pages, appends one
+  `?param=<value>` per selected value for each supported, not-already-present
+  dimension. `redirect` mode issues a single 302; `silent` mode rewrites
+  `request.GET`. API, GraphQL, and HTMX requests are skipped; existing query
+  params (pagination, sort, per_page) are preserved.
+
+## Differences from netbox-tenant-switcher
+
+| | `netbox-tenant-switcher` | `netbox-scope-switcher` |
+| --- | --- | --- |
+| Dimensions | tenant only (hard-coded) | any, configurable and grouped |
+| Cascade | — | filters narrow each other, both directions |
+| Control | one tenant field | one control, a section + chips per dimension |
+| Localization | — | labels/service words follow the UI language |
+| URL handling | redirect | redirect (default) or silent |
+| Session state | list of tenant ids | `{param: [values]}` dict |
+
+### Migrating
+
+1. `pip uninstall netbox-tenant-switcher` and remove it from `PLUGINS`.
+2. `pip install netbox-scope-switcher`, add `"netbox_scope_switcher"` to `PLUGINS`.
+3. Do nothing else for identical behaviour — the default config is the tenant
+   scope. Add more dimensions to `PLUGINS_CONFIG` when you want them.
+
+Sessions do not carry over (different key/shape); users simply re-pick their
+scope once.
+
+## Testing
+
+Tests live in `netbox_scope_switcher/tests/` and run inside a NetBox checkout:
+
+```bash
+python netbox/netbox/manage.py test netbox_scope_switcher -v 2
+```
+
+See `.github/workflows/ci.yml` for the full CI setup.
+
+## License
+
+[Apache-2.0](LICENSE).

netbox_scope_switcher-0.1.0/README.md

@@ -0,0 +1,194 @@
+# NetBox Scope Switcher
+
+**Pick your scope once — tenant, region, site, tag, whatever you configure — and
+every list in NetBox narrows to it, with the filters cascading on each other.**
+
+`netbox-scope-switcher` adds one compact, configurable selector to the top
+navigation bar. Choose values across any number of *scope dimensions* (grouped
+however you like) and, as you move between sections (Devices, Prefixes, VLANs,
+Sites, …), each list view is automatically scoped to your selection.
+
+It generalizes
+[`netbox-tenant-switcher`](https://github.com/Du10777/netbox-tenant-switcher):
+tenant is just the default dimension.
+
+## Screenshots
+
+![Grouped scope panel with a tenant selected; the Site list has cascaded to that tenant](docs/img/cascade.png)
+
+<p>
+  <img src="docs/img/panel.png" width="340" alt="Grouped dimensions: Tenant / Location / Tag">
+  <img src="docs/img/i18n.png" width="340" alt="Labels follow the NetBox UI language">
+</p>
+
+## Features
+
+- **Configurable, grouped dimensions.** Scope by tenant, tenant group, region,
+  site group, site, location, tag, or any filter you declare in `PLUGINS_CONFIG`
+  — arranged under your own group headings. No code changes.
+- **Cascading dependent filters.** Selecting values in one dimension narrows the
+  option lists of the others, in both directions: pick a *Tenant Group* and only
+  its tenants remain; pick a *Tenant* and Regions/Sites/Racks shrink to where that
+  tenant is present. Powered by NetBox's own filtersets (so tree descendants and
+  every relationship are honoured), with no hard-coded model knowledge.
+- **Token-style control.** One dropdown with a section per dimension: selected
+  values shown as removable chips, a `+ add` picker with instant search, an `Any`
+  placeholder, a `None` option (for objects with no value), per-dimension and
+  global *clear*. Chips stay name-sorted. No external JS dependencies.
+- **Localized.** Dimension labels come straight from each model's NetBox
+  `verbose_name`, and the service words are translated via NetBox's catalog, so
+  the panel follows the active UI language automatically.
+- **Resizable & viewport-bounded panel.** Drag the corner grip to resize (the
+  size is remembered for the session); the panel never grows past the screen and
+  scrolls internally.
+- **Honest URLs.** By default the plugin issues a single redirect that adds the
+  filter params to the address bar, so links are shareable, NetBox's own filter
+  panel shows them, and *Clear filters* behaves predictably. A `silent` mode is
+  available.
+- **Per-scope applicability.** Each dimension is applied only on list views whose
+  filterset actually supports it — a prefixes list may scope by tenant and tag but
+  not region — computed by introspection, not hard-coding. The control dims when
+  nothing applies to the current page.
+- **Combining semantics:** several values within a dimension are OR-combined;
+  different dimensions are AND-combined; `None` maps to `?param=null`.
+- **Permission-aware.** Only values the user may view are listed and selectable,
+  and scoping only ever *narrows* results — NetBox object permissions still apply
+  on top.
+- **No models, no migrations.** Selection lives in the session.
+
+## Compatibility
+
+| Plugin version | NetBox version | Python      |
+| -------------- | -------------- | ----------- |
+| 0.1.x          | 4.6            | 3.10 – 3.12 |
+
+Developed and verified against **NetBox 4.6**, using only stable plugin APIs
+(`PluginTemplateExtension.navbar()` / `head()`, plugin middleware). The CI matrix
+(`.github/workflows/ci.yml`) additionally exercises 4.4 and 4.5.
+
+## Installation
+
+```bash
+source /opt/netbox/venv/bin/activate
+pip install netbox-scope-switcher
+```
+
+Enable it in `configuration.py`:
+
+```python
+PLUGINS = ["netbox_scope_switcher"]
+```
+
+Restart NetBox (`sudo systemctl restart netbox netbox-rq`). No migrations needed.
+
+### Docker (netbox-docker)
+
+See [`deploy/`](deploy/) for a ready-to-use `Dockerfile-Plugins`,
+`docker-compose.override.yml`, and `plugins.py`.
+
+## Configuration
+
+Out of the box the plugin scopes by **tenant only** (matching
+`netbox-tenant-switcher`). To configure dimensions and grouping, set
+`PLUGINS_CONFIG`:
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_scope_switcher": {
+        "mode": "redirect",  # or "silent"
+        "scopes": [
+            {"param": "tenant_group_id", "model": "tenancy.TenantGroup", "group": "Tenant"},
+            {"param": "tenant_id",       "model": "tenancy.Tenant",      "group": "Tenant"},
+            {"param": "region_id",       "model": "dcim.Region",         "group": "Location"},
+            {"param": "site_group_id",   "model": "dcim.SiteGroup",      "group": "Location"},
+            {"param": "site_id",         "model": "dcim.Site",           "group": "Location"},
+            {"param": "location_id",     "model": "dcim.Location",       "group": "Location"},
+            {"param": "tag",             "model": "extras.Tag",          "group": "Tag",
+             "value_field": "slug"},
+        ],
+    }
+}
+```
+
+### `PLUGINS_CONFIG` keys
+
+| Key      | Type   | Default     | Description |
+| -------- | ------ | ----------- | ----------- |
+| `scopes` | list   | tenant only | Ordered list of scope dimensions (below). |
+| `mode`   | string | `redirect`  | `redirect` (add params to the URL via a 302) or `silent` (rewrite the request in place). |
+
+Each entry in `scopes`:
+
+| Field         | Required | Default            | Description |
+| ------------- | -------- | ------------------ | ----------- |
+| `param`       | yes      | —                  | GET parameter of the filter to apply (e.g. `tenant_id`, `tag`). |
+| `model`       | yes      | —                  | `app_label.ModelName` the dropdown values come from. |
+| `group`       | no       | —                  | Group heading to list this dimension under (translated via NetBox). |
+| `label`       | no       | model verbose name | Section heading. Omit it to follow the active UI language. |
+| `value_field` | no       | `pk`               | Value to put in the param: `pk` or `slug` (tags filter by slug). |
+
+The configuration is validated at startup: an unknown model or field raises a
+clear `ImproperlyConfigured` error on load, rather than a 500 at runtime.
+
+## How it works
+
+- **Navbar widget** (`template_content.py`) — a `PluginTemplateExtension` renders
+  the control + a section per dimension via `navbar()`; CSS/JS are injected once
+  via `head()`. Options are fetched from the values endpoint on open (so they can
+  cascade); only the static `None` option is server-rendered.
+- **Set endpoint** (`views.py`) — `GET /plugins/scope-switcher/set/` stores the
+  chosen values per dimension in the session and redirects back. `next` is
+  validated against the current host (no open redirects); every value is checked
+  against the user's view permission.
+- **Values endpoint** (`views.py`) —
+  `GET /plugins/scope-switcher/values/<param>/?q=…&<other>=…` returns a
+  permission-scoped, cascaded, searchable JSON option list.
+- **Cascade** (`cascade.py`) — narrows a dimension's options to those consistent
+  with the current selection in the others. A *forward* pass filters a model by
+  every other scope its own filterset supports (Site by Region, Rack by Location,
+  …); a *reverse* pass handles the "upward" direction by pivoting through a bridge
+  model that has a FK to the target and whose filterset does support the source
+  (Site bridges Region↔Tenant, Tenant bridges Tenant Group↔Tenant, …).
+- **Applicability** (`applicability.py`) — introspects the current list view's
+  filterset (`get_filters()` / `base_filters`) to decide which configured params
+  it supports; used to dim the control and to choose what to apply.
+- **Middleware** (`middleware.py`) — for `ObjectListView` pages, appends one
+  `?param=<value>` per selected value for each supported, not-already-present
+  dimension. `redirect` mode issues a single 302; `silent` mode rewrites
+  `request.GET`. API, GraphQL, and HTMX requests are skipped; existing query
+  params (pagination, sort, per_page) are preserved.
+
+## Differences from netbox-tenant-switcher
+
+| | `netbox-tenant-switcher` | `netbox-scope-switcher` |
+| --- | --- | --- |
+| Dimensions | tenant only (hard-coded) | any, configurable and grouped |
+| Cascade | — | filters narrow each other, both directions |
+| Control | one tenant field | one control, a section + chips per dimension |
+| Localization | — | labels/service words follow the UI language |
+| URL handling | redirect | redirect (default) or silent |
+| Session state | list of tenant ids | `{param: [values]}` dict |
+
+### Migrating
+
+1. `pip uninstall netbox-tenant-switcher` and remove it from `PLUGINS`.
+2. `pip install netbox-scope-switcher`, add `"netbox_scope_switcher"` to `PLUGINS`.
+3. Do nothing else for identical behaviour — the default config is the tenant
+   scope. Add more dimensions to `PLUGINS_CONFIG` when you want them.
+
+Sessions do not carry over (different key/shape); users simply re-pick their
+scope once.
+
+## Testing
+
+Tests live in `netbox_scope_switcher/tests/` and run inside a NetBox checkout:
+
+```bash
+python netbox/netbox/manage.py test netbox_scope_switcher -v 2
+```
+
+See `.github/workflows/ci.yml` for the full CI setup.
+
+## License
+
+[Apache-2.0](LICENSE).

netbox_scope_switcher-0.1.0/netbox_scope_switcher/__init__.py

@@ -0,0 +1,33 @@
+from netbox.plugins import PluginConfig
+
+
+class ScopeSwitcherConfig(PluginConfig):
+    name = 'netbox_scope_switcher'
+    verbose_name = 'Scope Switcher'
+    description = ('Adds a configurable, multi-dimension scope selector to the top '
+                   'navbar. Selecting values scopes list views by tenant, site, '
+                   'region, tag, and any other filter you configure.')
+    version = '0.1.0'
+    author = 'Du10777'
+    base_url = 'scope-switcher'
+    min_version = '4.4.0'
+    # Request-scoped filtering of list views by the selected scope values.
+    middleware = ['netbox_scope_switcher.middleware.ScopeSwitcherMiddleware']
+    # Defaults to a single tenant scope so the out-of-the-box behaviour matches
+    # netbox-tenant-switcher; override `scopes`/`mode` in PLUGINS_CONFIG.
+    default_settings = {
+        'scopes': [
+            {'param': 'tenant_id', 'model': 'tenancy.Tenant'},
+        ],
+        'mode': 'redirect',
+    }
+
+    def ready(self):
+        super().ready()
+        # Fail fast at startup with a clear message on a bad configuration,
+        # rather than raising a 500 somewhere in the request path.
+        from .config import validate_config
+        validate_config()
+
+
+config = ScopeSwitcherConfig