Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs on using editable install for plugin development (#6083)

Browse Source 
* Add docs on using editable install for plugin development

* Add info
This commit is contained in:
Oliver 2023-12-14 14:24:00 +11:00 committed by GitHub
parent 99c92ff655
commit 17068ca5a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/docs/extend/how_to_plugin.md
View File

@ -107,6 +107,27 @@ recursive-include my_plugin/templates *
Other files and directories can be copied in a similar manner. Other files and directories can be copied in a similar manner.
### Local Plugin Development
If you are developing a plugin (either from scratch, or making changes to an existing plugin), it can be useful to install the plugin using an [editable install](https://setuptools.pypa.io/en/latest/userguide/development_mode.html).
An *editable install* installs the plugin (via PIP) into your local python virtual environment, but does not *copy* the code into the environment. Instead, it loads the code directly from where it is located, and also monitors for live changes in the code. This means that you can make changes to the plugin on the fly, and the InvenTree development server will detect any code changes and re-load the plugin automatically.
Note that to use an *editable install*, your plugin must be installable via PIP.
#### Example
To setup an editable install:
- Download the source code for the plugin (or create a new plugin)
- Ensure that your setup file (either `setup.py` or `pyproject.toml`) is valid
- Launch a command line and activate your development virtual environment
- `cd` into the top-level directory of your plugin project, where the setup file is located
- Setup an editable install with the following command:
```bash
pip install --editable .
```
### A simple example ### A simple example
This example adds a new action under `/api/action/sample` using the ActionMixin. This example adds a new action under `/api/action/sample` using the ActionMixin.