InvenTree Plugin Creator
Command line tool for scaffolding a new InvenTree plugin.
Description
This is a command line tool which allows for rapid scaffolding of a new InvenTree plugin.
It uses the cookiecutter project to generate a new project, based on a custom project template.
InvenTree Version
The plugin creator tool is designed to target InvenTree version 1.0.0 (or newer). The code generated by this tool is not guaranteed to work for older versions of the InvenTree software.
Installation
To install the plugin creator, run:
pip install -U inventree-plugin-creator
or directly execute the create command if you have uv installed:
uvx --from inventree-plugin-creator create-inventree-plugin
Usage
As a starting point, refer to the plugin creator documentation
To create a new plugin, run:
create-inventree-plugin
This will prompt you for required information about the plugin you wish to create.
To view the available options, run:
create-inventree-plugin --help
Frontend Features
If you are developing a plugin which provides frontend (UI) features, after creating the initial plugin, run the following commands to install and build the initial version of the frontend code:
cd <myplugin>/frontend
npm install
npm run build
This will compile frontend code into the <myplugin>/static directory - ready to be packaged and distributed with the python plugin code.
Note: You must run npm run build each time before building and distributing the plugin.
Release files for inventree-plugin-creator 1.20.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| inventree_plugin_creator-1.20.1.tar.gz | 28.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| inventree_plugin_creator-1.20.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 79.1 kB
Release files / inventree_plugin_creator-1.20.1.tar.gz
| Download URL | inventree_plugin_creator-1.20.1.tar.gz |
|---|---|
| Size | 28.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa12ccfa466fbf1b4d5933861ae2e4fe1c6fd0beb9d7cfaaa5e20ac718008af1
|
|
BLAKE2b-256 checksum How to use checksums |
4dc265453adafd085d537f404e98061cab5bcbd70a9c31eff1ca1c45b0f61061
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / inventree_plugin_creator-1.20.1-py3-none-any.whl
| Download URL | inventree_plugin_creator-1.20.1-py3-none-any.whl |
|---|---|
| Size | 50.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
57624a123faf4bf32d60b863eab8024a0d7a5a22fe91a5a6ac93b2fb7c8c5e56
|
|
BLAKE2b-256 checksum How to use checksums |
0cf82a2a1f306fe46c243e7ba21bd55123ad1ce1627031e3527d15f1660ac30f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
