starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Document how plugin settings are used #6974

New Issue
Closed
opened 2025-12-29 19:47:22 +01:00 by adam · 2 comments
adam commented 2025-12-29 19:47:22 +01:00
Owner
Copy Link

Originally created by @hagbarddenstore on GitHub (Sep 12, 2022).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Addition

Area

Functionality/features

Proposed Changes

In the plugin development section, it is not documented how a plugin should access its own settings.

from django.conf import settings

settings.PLUGINS_CONFIG['plugin_name']['settings_key']

This method works and is Django standard, but NetBox populates the dict with the defaults from the plugin configuration.

I think this should be documented.

Originally created by @hagbarddenstore on GitHub (Sep 12, 2022). Originally assigned to: @jeremystretch on GitHub. ### Change Type Addition ### Area Functionality/features ### Proposed Changes In the plugin development section, it is not documented how a plugin should access its own settings. ``` from django.conf import settings settings.PLUGINS_CONFIG['plugin_name']['settings_key'] ``` This method works and is Django standard, but NetBox populates the dict with the defaults from the plugin configuration. I think this should be documented.
adam added the status: acceptedtype: documentation labels 2025-12-29 19:47:22 +01:00
adam closed this issue 2025-12-29 19:47:22 +01:00
adam commented 2025-12-29 19:47:22 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 13, 2022):

Maybe it makes sense to provide a helper utility and document its use instead? That might be a bit cleaner for developers, and provide a hook layer for potential future use. Something like:

from extras.plugins import get_plugin_config

myvar = get_plugin_config('plugin_name', 'myvar')
@jeremystretch commented on GitHub (Sep 13, 2022): Maybe it makes sense to provide a helper utility and document its use instead? That might be a bit cleaner for developers, and provide a hook layer for potential future use. Something like: ```python from extras.plugins import get_plugin_config myvar = get_plugin_config('plugin_name', 'myvar') ```
adam commented 2025-12-29 19:47:23 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Sep 20, 2022):

I think an associated templatetag might also be wise.

@DanSheps commented on GitHub (Sep 20, 2022): I think an associated templatetag might also be wise.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6974
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?