Skip to content

Commit 815bab3

Browse files
authored
Merge pull request #31 from stiltzkin10/fix-docs-update
Update project layout and install instructions
2 parents 1c68751 + ec80bbf commit 815bab3

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/tutorial.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,18 @@ Go to this generated folder, the project layout should look like:
3838
.
3939
├── CHANGELOG.md
4040
├── CONTRIBUTING.md
41-
├── LICENSE
42-
├── MANIFEST.in
43-
├── Makefile
44-
├── README.md
4541
├── docs
4642
│   ├── changelog.md
4743
│   ├── contributing.md
4844
│   └── index.md
45+
├── LICENSE
46+
├── Makefile
47+
├── MANIFEST.in
4948
├── mkdocs.yml
5049
├── netbox_healthcheck_plugin
51-
│   ├── __init__.py
5250
│   ├── filtersets.py
5351
│   ├── forms.py
52+
│   ├── __init__.py
5453
│   ├── models.py
5554
│   ├── navigation.py
5655
│   ├── tables.py
@@ -59,9 +58,9 @@ Go to this generated folder, the project layout should look like:
5958
│   │   └── healthcheck.html
6059
│   ├── urls.py
6160
│   └── views.py
61+
├── pyproject.toml
62+
├── README.md
6263
├── requirements_dev.txt
63-
├── setup.cfg
64-
├── setup.py
6564
└── tests
6665
├── __init__.py
6766
└── test_netbox_healthcheck_plugin.py
@@ -74,10 +73,10 @@ Here the plugin_name is `HealthCheck`, when you generate yours, it could be othe
7473

7574
Go to your NetBox development environment and make sure the NetBox virtual environment is active. See [Create Python Virtual Environment](https://docs.netbox.dev/en/stable/development/getting-started/#4-create-a-python-virtual-environment).
7675

77-
To ease development, it is recommended to go ahead and install the plugin at this point using setuptools' `develop` mode. This will create symbolic links within your Python environment to the plugin development directory. Call `setup.py` from the plugin's root directory with the `develop` argument (instead of `install`):
76+
To ease development, it is recommended to go ahead and install the plugin in editable mode (i.e setuptools' develop mode). Call pip from the plugin's root directory with the `-e` flag:
7877

7978
```no-highlight
80-
$ python setup.py develop
79+
$ pip install -e .
8180
```
8281

8382
## Step 4: Configure NetBox

0 commit comments

Comments
 (0)