Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update project layout and install instructions #31

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update project layout and install instructions #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,18 @@ Go to this generated folder, the project layout should look like:
.
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── docs
│   ├── changelog.md
│   ├── contributing.md
│   └── index.md
├── LICENSE
├── Makefile
├── MANIFEST.in
├── mkdocs.yml
├── netbox_healthcheck_plugin
│   ├── __init__.py
│   ├── filtersets.py
│   ├── forms.py
│   ├── __init__.py
│   ├── models.py
│   ├── navigation.py
│   ├── tables.py
Expand All @@ -59,9 +58,9 @@ Go to this generated folder, the project layout should look like:
│   │   └── healthcheck.html
│   ├── urls.py
│   └── views.py
├── pyproject.toml
├── README.md
├── requirements_dev.txt
├── setup.cfg
├── setup.py
└── tests
├── __init__.py
└── test_netbox_healthcheck_plugin.py
Expand All @@ -74,10 +73,10 @@ Here the plugin_name is `HealthCheck`, when you generate yours, it could be othe

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).

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`):
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:

```no-highlight
$ python setup.py develop
$ pip install -e .
```

## Step 4: Configure NetBox
Expand Down