Support & Community
If you need help, Join our Discord server: https://discord.com/invite/utv9qWsnRY or e-mail us on: support@netpicker.io
NetBox Automation & Config Backup Plugin
Netbox plugin to automatically Automate & Backup your Network with Netpicker.
Compatibility
| NetBox Version | Plugin Version |
|---|---|
| NetBox 4.6 | >= 1.1.x |
| NetBox 4.5 | >= 1.0.x |
| NetBox 4.4 | >= 0.9.x |
| NetBox 4.3 | >= 0.8.x |
Features
- Netpicker Configuration View: Integrated interface for managing Netpicker configurations within Netbox
- Simple Automation: Streamlined automation workflows for network operations
Installation
Option 1: PyPI Installation
The plugin is available as a Python package on PyPI and can be installed with pip:
# Activate your Netbox virtual environment
source /opt/netbox/venv/bin/activate
# Install the plugin
pip install --no-cache-dir netpicker-netbox-plugin
Option 2: Development Installation
For development or custom modifications:
# Clone the repository
git clone <repository-url>
cd netpicker-netbox-plugin
# Install dependencies
poetry install
# Install in development mode
poetry run pip install -e .
Configuration
1. Add to Netbox Configuration
Add the plugin to your netbox.conf.py or environment variables:
PLUGINS = [
'netpicker',
]
2. Run Database Migrations
python manage.py migrate
3. Create Super User (if needed)
python manage.py createsuperuser
4. Restart Netbox
Restart your Netbox service to load the plugin:
# If using systemd
sudo systemctl restart netbox
# If using Docker
docker compose restart netbox
Docker Deployment
The project includes Docker support for easy deployment:
# Start all services
docker compose up -d --build
# View logs
docker compose logs -f netbox
# Stop services
docker compose down
The Docker setup includes:
- Netbox application
- Netbox worker for background tasks
- Netbox housekeeping
- PostgreSQL database
- Redis for caching and sessions
Usage
Once installed and configured, the Netpicker plugin will be available in your Netbox interface:
- Navigate to the Netpicker section in the Netbox navigation
- Access configuration views and automation tools
- Use the API endpoints for programmatic access
API Endpoints
The plugin provides REST API endpoints accessible at /api/plugins/netpicker/.
Development
For development information, see DEVELOPMENT.md.
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- Submit a pull request
Support
For issues and questions:
- Create an issue in the repository
- Contact the maintainers
- Send an email to support@netpicker.io
1 maintainer
Metadata
1 maintainer
Release files for netpicker-netbox-plugin 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| netpicker_netbox_plugin-1.1.2.tar.gz | 45.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| netpicker_netbox_plugin-1.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 113.7 kB
Release files / netpicker_netbox_plugin-1.1.2.tar.gz
| Download URL | netpicker_netbox_plugin-1.1.2.tar.gz |
|---|---|
| Size | 45.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0fa05039ad473ecd2937fe19e614aa159be75b5ff594bf1ea4c50624bb0d4639
|
|
BLAKE2b-256 checksum How to use checksums |
4374be837b659193de5c9bbe04358cd47b4f4eec371407073286a5ac33803a38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.13.14 Linux/5.15.0-174-generic
|
Release files / netpicker_netbox_plugin-1.1.2-py3-none-any.whl
| Download URL | netpicker_netbox_plugin-1.1.2-py3-none-any.whl |
|---|---|
| Size | 68.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
97402b771be16d8d20773a0a4ba359725365fe0352fdd51802b5564afdb2e20a
|
|
BLAKE2b-256 checksum How to use checksums |
fc77a78e00b3e97e52e97955c227b64121b1a977ef35bee31a09a375ab3c2695
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.13.14 Linux/5.15.0-174-generic
|
Security for netpicker-netbox-plugin 1.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
