Metadata-Version: 2.4
Name: netbox-rack-design
Version: 0.1.0
Summary: NetBox plugin for Rack Design.
Author-email: Petr Voronov <ravenrs@gmail.com>
Project-URL: Documentation, https://github.com/ravenrs/netbox-rack-design/blob/main/README.md
Project-URL: Source, https://github.com/ravenrs/netbox-rack-design
Project-URL: Tracker, https://github.com/ravenrs/netbox-rack-design/issues
Keywords: netbox,netbox-plugin
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.1
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Natural Language :: English
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.0
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: check-manifest==0.51; extra == "test"
Requires-Dist: ruff==0.14.14; extra == "test"
Requires-Dist: pre-commit==6.0.0; extra == "test"
Requires-Dist: pytest==9.0.2; extra == "test"
Dynamic: license-file

# NetBox Rack Design

NetBox plugin for Rack Design.


* Free software: Apache-2.0
* Documentation: https://ravenrs.github.io/netbox-rack-design/


## Features

The features the plugin provides should be listed here. For example:

- Manage Rack Design resources through NetBox UI
- Track and organize Rack Design data with custom fields and tags
- REST API endpoints for programmatic access
- GraphQL support for flexible data queries
- Full change logging and journaling support
- Integration with NetBox's permission system
- Global search integration for finding Rack Design objects
- Comprehensive filtering and table views

## Screenshots

<!-- Add screenshots or GIFs demonstrating your plugin's functionality here -->
_Screenshots will be added as features are developed._

## Compatibility

This plugin targets **NetBox 4.4.x**.

| NetBox Version | Plugin Version |
|----------------|----------------|
|     4.4.x      |      0.1.0     |

For more detailed compatibility information, see [COMPATIBILITY.md](COMPATIBILITY.md).

## Dependencies

This plugin requires:
- NetBox 4.4.0 – 4.4.x
- Python 3.10 – 3.12

No additional Python packages are required beyond NetBox's core dependencies.

## REST API

This plugin provides a REST API endpoint for managing Rack Design resources:

- `/api/plugins/netbox_rack_design/rack-designs/` - List and create Rackdesign objects


## GraphQL

This plugin provides GraphQL support for querying Rack Design resources through NetBox's GraphQL API.


## Installing

For adding to a NetBox Docker setup see
[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).

While this is still in development and not yet on pypi you can install with pip:

```bash
pip install git+https://github.com/ravenrs/netbox-rack-design
```

or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):

```bash
git+https://github.com/ravenrs/netbox-rack-design
```

Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
 or if you use netbox-docker, your `/configuration/plugins.py` file :

```python
PLUGINS = [
    'netbox_rack_design'
]

PLUGINS_CONFIG = {
    "netbox_rack_design": {},
}
```

## Configuration

This plugin does not require any additional configuration by default. Optional configuration parameters can be added to `PLUGINS_CONFIG` in your NetBox configuration file as needed.

## Usage

For detailed usage instructions, please refer to the [documentation](https://ravenrs.github.io/netbox-rack-design/).

## Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

### Reporting Bugs

Please report bugs by opening an issue on our [GitHub Issues](https://github.com/ravenrs/netbox-rack-design/issues) page. When reporting bugs, please include:

- NetBox version
- Plugin version
- Python version
- Steps to reproduce
- Expected behavior
- Actual behavior

### Feature Requests

Feature requests can be submitted as [GitHub Issues](https://github.com/ravenrs/netbox-rack-design/issues) with the "enhancement" label.

## Support

- **Documentation**: https://ravenrs.github.io/netbox-rack-design/
- **Issues**: https://github.com/ravenrs/netbox-rack-design/issues
- **Discussions**: https://github.com/ravenrs/netbox-rack-design/discussions
- **NetBox Community Slack**: [netdev-community.slack.com](https://netdev.chat/)

## Credits

Based on the NetBox plugin tutorial:

- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.
