Explore importing script projects from installed Python packages

Open
  • Is something wrong?
#42 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
python
Domain
backend

Research direction

No files, tests, or entry points are named. Start by reading the proposed functionality and related NetBox issue #11923, then document agreement on the provider contract, entrypoint ownership, provenance, dependency handling, upgrade behavior, and explicit safety boundaries.

Written by the indexing model from the issue text.

Description

app: scripts complexity: high status: backlog type: feature
Plugin Version

v0.0.1

Proposed functionality

Discuss an explicit way to import a Script Project supplied by an installed Python package or NetBox plugin. An administrator would select the provider and import source into a normal revision for validation and activation.

Agree the provider contract, entrypoint ownership, and upgrade behavior first. Package upgrades should create candidates, not silently replace active source. Record package and version provenance, and explain the installed dependencies an older revision still needs.

Keep source immutable. Do not automatically publish imported Script classes, write to legacy SCRIPTS_ROOT, install packages, or allow unrestricted cross-project imports. The initial goal is agreement on the use case and design, not a commitment to a discovery mechanism.

Use case

Package and plugin authors may distribute maintenance or provisioning scripts. Administrators need a deliberate, repeatable way to adopt them without copying files manually after each upgrade.

Related request: netbox-community/netbox#11923.

External dependencies

The provider package must already be installed by an administrator. Other dependencies depend on the agreed design.

Dominant language
Python
Stars
8
Forks
0
Avg merge
9h 56m
Merged PRs (30d)
29

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from netbox-community/netbox-scripts

All issues in netbox-community/netbox-scripts

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.