Metadata-Version: 2.4
Name: netboxlabs-netbox-custom-objects
Version: 1.0.0
Summary: A plugin to manage custom objects in NetBox
Author-email: NetBox Labs <support@netboxlabs.com>
Maintainer-email: NetBox Labs <support@netboxlabs.com>
Project-URL: Homepage, https://github.com/netboxlabs/netbox-custom-objects
Project-URL: Documentation, https://netboxlabs.com/docs/extensions/custom-objects/
Project-URL: Source, https://github.com/netboxlabs/netbox-custom-objects
Project-URL: Issues, https://github.com/netboxlabs/netbox-custom-objects/issues
Project-URL: Changelog, https://github.com/netboxlabs/netbox-custom-objects/releases
Keywords: netbox,netbox-plugin
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: System :: Networking
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: Django
Requires-Dist: jsonschema
Requires-Dist: packaging
Requires-Dist: PyYAML
Provides-Extra: dev
Requires-Dist: build==1.2.2; extra == "dev"
Requires-Dist: pre-commit==4.7.0; extra == "dev"
Requires-Dist: ruff==0.15.14; extra == "dev"
Requires-Dist: twine==6.1.0; extra == "dev"
Provides-Extra: test
Requires-Dist: check-manifest==0.51; extra == "test"
Requires-Dist: coverage[toml]==7.17.0; extra == "test"
Requires-Dist: tblib==3.2.2; extra == "test"
Provides-Extra: docs
Requires-Dist: mkdocs==1.6.1; extra == "docs"
Requires-Dist: mkdocs-material==9.8.0; extra == "docs"
Requires-Dist: zensical==0.0.43; extra == "docs"
Provides-Extra: branching
Requires-Dist: netboxlabs-netbox-branching>=1.0.4; extra == "branching"
Dynamic: license-file

# NetBox Custom Objects

This [NetBox](https://netboxlabs.com/products/netbox/) plugin introduces the ability to create new object types in NetBox so that users can add models to suit their own needs. NetBox users have been able to extend the NetBox data model for some time using both Tags & Custom Fields and Plugins. Tags and Custom Fields are easy to use, but they have limitations when used at scale, and Plugins are very powerful but require Python/Django knowledge, and ongoing maintenance. Custom Objects provides users with a no-code "sweet spot" for data model extensibility, providing a lot of the power of NetBox plugins, but with the ease of use of Tags and Custom Fields.

You can find further documentation [here](https://netboxlabs.com/docs/extensions/custom-objects/). See the [compatibility matrix](https://github.com/netboxlabs/netbox-custom-objects/blob/main/COMPATIBILITY.md) for supported NetBox versions.

## Installation

1. Install the NetBox Custom Objects package.

```
pip install netboxlabs-netbox-custom-objects
```

2. Add `netbox_custom_objects` to `PLUGINS` in `configuration.py`.

```python
PLUGINS = [
    # ...
    'netbox_custom_objects',
]
```

3. Run NetBox migrations and collect static files:

```
$ ./manage.py migrate
$ ./manage.py collectstatic
```

4. Restart NetBox
```
sudo systemctl restart netbox netbox-rq
```

## Custom Objects Tab

When a custom object references a NetBox object, or another custom object, through an object or multi-object field, the referenced object's page gets a **Custom Objects** tab listing every custom object that links to it. See the [documentation](https://netboxlabs.com/docs/extensions/custom-objects/related-objects-tab/) for details.

## Roadmap

NetBox Custom Objects is Generally Available, which means you can use it in production and migrations to future versions will work. The best place to see what's on the way is the [issues](https://github.com/netboxlabs/netbox-custom-objects/issues) list on the GitHub repository.
