Skip to content

Commit 6958f2c

Browse files
minitrigaminitriga
committed
INIT
0 parents  commit 6958f2c

File tree

32 files changed

+6480
-0
lines changed

32 files changed

+6480
-0
lines changed

‎.github/workflows/pre-commit.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: pre-commit
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [main]
7+
8+
jobs:
9+
pre-commit:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: actions/setup-python@v3
14+
- uses: pre-commit/[email protected]

‎.github/workflows/python-publish.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Upload Python Package
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- name: Set up Python
13+
uses: actions/setup-python@v4
14+
with:
15+
python-version: '3.x'
16+
- name: Install dependencies
17+
run: |
18+
python -m pip install --upgrade pip
19+
pip install build
20+
- name: Build package
21+
run: python -m build
22+
- name: Publish package
23+
uses: pypa/gh-action-pypi-publish@release/v1
24+
with:
25+
password: ${{ secrets.PYPI_API_TOKEN }}

‎.gitignore‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/
161+
162+
netbox_reorder_rack/static_dev/node_modules/

‎.pre-commit-config.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v2.3.0
4+
hooks:
5+
- id: check-yaml
6+
- id: end-of-file-fixer
7+
- id: trailing-whitespace
8+
- repo: https://github.com/asottile/reorder-python-imports
9+
rev: v3.12.0
10+
hooks:
11+
- id: reorder-python-imports
12+
- repo: https://github.com/astral-sh/ruff-pre-commit
13+
# Ruff version.
14+
rev: v0.3.1
15+
hooks:
16+
# Run the linter.
17+
- id: ruff
18+
args: [ --fix ]
19+
# Run the formatter.
20+
- id: ruff-format

‎MANIFEST.in‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
recursive-include netbox_reorder_rack/static *
2+
recursive-include netbox_reorder_rack/templates *

‎README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Netbox Reorder Rack Plugin
2+
3+
![Version](https://img.shields.io/pypi/v/netbox-reorder-rack) ![Downloads](https://img.shields.io/pypi/dm/netbox-reorder-rack)
4+
5+
Allow the ability to reorder rack units in NetBox using a drag and drop interface.
6+
7+
![Reorder Rack](docs/img/netbox-reorder-rack.gif)
8+
9+
## Installation
10+
11+
**_NOTE:_** For docker please see: [Docker install](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins)
12+
13+
The plugin is available as a Python package and can be installed with pip.
14+
15+
Run the following commands to install the required package after activating the virtual environment:
16+
17+
```shell
18+
source /opt/netbox/venv/bin/activate
19+
pip install netbox-reorder-rack
20+
```
21+
22+
To ensure the plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if it does not exist already) in the NetBox root directory (alongside `requirements.txt`) and list the `netbox-reorder-rack` package:
23+
24+
```shell
25+
echo netbox-reorder-rack >> local_requirements.txt
26+
```
27+
28+
Once installed, the plugin needs to be enabled in your `configuration.py`
29+
30+
```python
31+
# In your configuration.py
32+
PLUGINS = ["netbox_reorder_rack"]
33+
```
34+
35+
You may need to collect static files and restart NetBox for the plugin to be properly installed.
36+
37+
```shell
38+
python3 manage.py collectstatic --no-input
39+
systemctl restart netbox
40+
```
41+
42+
43+
## Compatibility Matrix
44+
45+
| netbox version | plugin version |
46+
| -------------- | ----------------------------- |
47+
| >= 3.7.0 | >= v1.0.0 |
48+
49+
### Update
50+
51+
To update the plugin, you need to update the package and restart NetBox.
52+
53+
```shell
54+
source /opt/netbox/venv/bin/activate
55+
pip install netbox-reorder-rack
56+
python3 manage.py collectstatic --no-input
57+
systemctl restart netbox
58+
```

‎docs/img/development.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Development - Netbox Reorder Rack
2+
3+
## Installation
4+
```shell
5+
git clone ...
6+
cd netbox-reorder-rack
7+
source /opt/netbox/venv/bin/activate
8+
pip install -e .
9+
```
10+
11+
Edit `configuration.py` to include the plugin:
12+
```python
13+
PLUGINS = ["netbox_reorder_rack"]
14+
```
15+
16+
Start the development server:
17+
```shell
18+
python3 manage.py runserver
19+
```
20+
21+
## JavaScript Development
22+
To edit javascript you must change files contained within static_dev and then run the following command to compile the javascript:
23+
```shell
24+
node bundle.js
25+
```
26+
27+
## Build

‎docs/img/netbox-reorder-rack.gif‎

1.39 MB
Loading

‎netbox_reorder_rack/__init__.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
from extras.plugins import PluginConfig
2+
3+
4+
class NetboxReorderRackConfig(PluginConfig):
5+
name = "netbox_reorder_rack"
6+
verbose_name = "NetBox Reorder Rack"
7+
description = "NetBox plugin to reorder rack layouts."
8+
version = "1.0.0"
9+
base_url = "reorder"
10+
11+
12+
config = NetboxReorderRackConfig

‎netbox_reorder_rack/api/__init__.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)