[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/inventree-plugin-creator/)
# 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](https://cookiecutter.readthedocs.io/en/stable/) 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:
```bash
pip install -U inventree-plugin-creator
```
## Usage
As a starting point, refer to the [plugin creator documentation](https://docs.inventree.org/en/latest/plugins/creator/)
To create a new plugin, run:
```bash
create-inventree-plugin
```
This will prompt you for required information about the plugin you wish to create.
To view the available options, run:
```bash
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:
```bash
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.*
Raw data
{
"_id": null,
"home_page": "https://github.com/inventree/plugin-creator",
"name": "inventree-plugin-creator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "inventree plugin scaffold",
"author": "Oliver Walters",
"author_email": "oliver.henry.walters@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3f/22/d4ff06b8b0e8369a9ed1bca7fb4dc2338eff530a156747b47a8d53118e86/inventree_plugin_creator-1.13.3.tar.gz",
"platform": null,
"description": "[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/inventree-plugin-creator/)\n\n# InvenTree Plugin Creator\n\nCommand line tool for scaffolding a new InvenTree plugin.\n\n## Description\n\nThis is a command line tool which allows for rapid scaffolding of a new InvenTree plugin.\n\nIt uses the [cookiecutter project](https://cookiecutter.readthedocs.io/en/stable/) to generate a new project, based on a custom project template.\n\n## InvenTree Version\n\nThe 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. \n\n## Installation\n\nTo install the plugin creator, run:\n\n```bash\npip install -U inventree-plugin-creator\n```\n\n## Usage\n\nAs a starting point, refer to the [plugin creator documentation](https://docs.inventree.org/en/latest/plugins/creator/)\n\nTo create a new plugin, run:\n\n```bash\ncreate-inventree-plugin\n```\n\nThis will prompt you for required information about the plugin you wish to create.\n\nTo view the available options, run:\n\n```bash\ncreate-inventree-plugin --help\n```\n\n## Frontend Features\n\nIf 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:\n\n```bash\ncd <myplugin>/frontend\nnpm install\nnpm run build\n```\n\nThis will compile frontend code into the `<myplugin>/static` directory - ready to be packaged and distributed with the python plugin code.\n\n*Note: You must run `npm run build` each time before building and distributing the plugin.*\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "InvenTree plugin creator",
"version": "1.13.3",
"project_urls": {
"Homepage": "https://github.com/inventree/plugin-creator"
},
"split_keywords": [
"inventree",
"plugin",
"scaffold"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3905d2e96772e6d4e684f3c7029e9fe6facde994d72fd64361647513737c22cf",
"md5": "921c64639f5d1b28877992b198d18bc0",
"sha256": "229202e5fcca2547027aec89078de376a7a4e62b7d1ea2388ae62c385cf84fb5"
},
"downloads": -1,
"filename": "inventree_plugin_creator-1.13.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "921c64639f5d1b28877992b198d18bc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 48835,
"upload_time": "2025-10-16T11:52:03",
"upload_time_iso_8601": "2025-10-16T11:52:03.693736Z",
"url": "https://files.pythonhosted.org/packages/39/05/d2e96772e6d4e684f3c7029e9fe6facde994d72fd64361647513737c22cf/inventree_plugin_creator-1.13.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3f22d4ff06b8b0e8369a9ed1bca7fb4dc2338eff530a156747b47a8d53118e86",
"md5": "433133a4c6e49a312c2c2a8414a9dc13",
"sha256": "91975633ebe3d288aa256a5658f422832d9762f3b792cc3e566dc79e42fc696e"
},
"downloads": -1,
"filename": "inventree_plugin_creator-1.13.3.tar.gz",
"has_sig": false,
"md5_digest": "433133a4c6e49a312c2c2a8414a9dc13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 26944,
"upload_time": "2025-10-16T11:52:04",
"upload_time_iso_8601": "2025-10-16T11:52:04.964824Z",
"url": "https://files.pythonhosted.org/packages/3f/22/d4ff06b8b0e8369a9ed1bca7fb4dc2338eff530a156747b47a8d53118e86/inventree_plugin_creator-1.13.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-16 11:52:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "inventree",
"github_project": "plugin-creator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "inventree-plugin-creator"
}
JSON
