inventree-plugin-creator


Nameinventree-plugin-creator JSON
Version 1.8.1 PyPI version JSON
download
home_pagehttps://github.com/inventree/plugin-creator
SummaryInvenTree plugin creator
upload_time2025-07-25 01:39:10
maintainerNone
docs_urlNone
authorOliver Walters
requires_python>=3.9
licenseMIT
keywords inventree plugin scaffold
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI](https://img.shields.io/pypi/v/inventree-plugin-creator)](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.

## Installation

To install the plugin creator, run:

```bash
pip install -U inventree-plugin-creator
```

## Usage

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/e1/45/aed25ee047e83cc3e41cadb390a8dc1bfc72ddecf6e0ba6d6b941e1e9125/inventree_plugin_creator-1.8.1.tar.gz",
    "platform": null,
    "description": "[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PyPI](https://img.shields.io/pypi/v/inventree-plugin-creator)](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## Installation\n\nTo install the plugin creator, run:\n\n```bash\npip install -U inventree-plugin-creator\n```\n\n## Usage\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",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "InvenTree plugin creator",
    "version": "1.8.1",
    "project_urls": {
        "Homepage": "https://github.com/inventree/plugin-creator"
    },
    "split_keywords": [
        "inventree",
        "plugin",
        "scaffold"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0cbfdec8b8b2dd1ce1103272c92dbd4b3e8e2b15caff0e35f223ae38d884818a",
                "md5": "0e7c08d401e4c41732293f52cab6bcd0",
                "sha256": "efaddf687f637fa8628463d851e8ec85dfa21325e936efd7b15385da04259daa"
            },
            "downloads": -1,
            "filename": "inventree_plugin_creator-1.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0e7c08d401e4c41732293f52cab6bcd0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 37792,
            "upload_time": "2025-07-25T01:39:09",
            "upload_time_iso_8601": "2025-07-25T01:39:09.464600Z",
            "url": "https://files.pythonhosted.org/packages/0c/bf/dec8b8b2dd1ce1103272c92dbd4b3e8e2b15caff0e35f223ae38d884818a/inventree_plugin_creator-1.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e145aed25ee047e83cc3e41cadb390a8dc1bfc72ddecf6e0ba6d6b941e1e9125",
                "md5": "ea89bf91ae78fefe934ce37be876ed5e",
                "sha256": "7db2676818755f33898a771f437b68b76d5fa2a73018cfcec3e8b2c97c8d156e"
            },
            "downloads": -1,
            "filename": "inventree_plugin_creator-1.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ea89bf91ae78fefe934ce37be876ed5e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 23508,
            "upload_time": "2025-07-25T01:39:10",
            "upload_time_iso_8601": "2025-07-25T01:39:10.572740Z",
            "url": "https://files.pythonhosted.org/packages/e1/45/aed25ee047e83cc3e41cadb390a8dc1bfc72ddecf6e0ba6d6b941e1e9125/inventree_plugin_creator-1.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-25 01:39:10",
    "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"
}
Oliver Walters
Elapsed time: 0.51933s