# inventree-template-editor-plugin
[![License: GPL3](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/license/gpl-3-0)
![CI](https://github.com/wolflu05/inventree-template-editor-plugin/actions/workflows/ci.yml/badge.svg)
A visual editor to quickly build InvenTree label templates.
![](https://github.com/user-attachments/assets/2879e1ac-7fd5-4008-a740-34438620fb2b)
## ⚙️ Installation
Install this plugin as follows:
1. Goto the Admin Center > Plugins > Plugin Settings and make sure to enable the "Enable interface integration" switch.
2. Click on "Install Plugin" at the top of the Plugins table on that page and enter `inventree-template-editor-plugin` as package name. Enable the "Confirm plugin installation" switch and click "Install".
3. Search for the plugin in the table and activate it
> [!IMPORTANT]
> At least InvenTree v0.17 is required to use this plugin.
## 🏃 Usage
Goto the Admin Center > Label Templates and create a new Label template. Click on it in the table and select the "Label Designer". Click on the shapes on the left bar to add them to the label canvas.
## 🧑💻 Development
1. Install as editable install to your inventree installation via `pip install -e /path/to/inventree-template-editor-plugin`
2. Enable the plugin
3. Install js dependencies via `cd inventree_template_editor/frontend && npm ci`
4. Enable the dev mode for the plugin to use the vite dev server (that you need to start via `npm run dev`) in the InvenTree `config.yml` via `customize.inventree_template_editor_plugin_dev: true`
5. Restart InvenTree and start vite dev server via `npm run dev`
Raw data
{
"_id": null,
"home_page": "https://github.com/wolflu05/inventree-template-editor-plugin",
"name": "inventree-template-editor-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "inventree template editor label",
"author": "wolflu05",
"author_email": "76838159+wolflu05@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/cf/64/601e9c5b1a175db87343b10070da753c0a56396d23de963ccdde1f3933e8/inventree_template_editor_plugin-0.1.0.tar.gz",
"platform": null,
"description": "# inventree-template-editor-plugin\n\n[![License: GPL3](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/license/gpl-3-0)\n![CI](https://github.com/wolflu05/inventree-template-editor-plugin/actions/workflows/ci.yml/badge.svg)\n\nA visual editor to quickly build InvenTree label templates.\n\n![](https://github.com/user-attachments/assets/2879e1ac-7fd5-4008-a740-34438620fb2b)\n\n## \u2699\ufe0f Installation\n\nInstall this plugin as follows:\n\n1. Goto the Admin Center > Plugins > Plugin Settings and make sure to enable the \"Enable interface integration\" switch.\n\n2. Click on \"Install Plugin\" at the top of the Plugins table on that page and enter `inventree-template-editor-plugin` as package name. Enable the \"Confirm plugin installation\" switch and click \"Install\".\n\n3. Search for the plugin in the table and activate it\n\n> [!IMPORTANT]\n> At least InvenTree v0.17 is required to use this plugin.\n\n## \ud83c\udfc3 Usage\n\nGoto the Admin Center > Label Templates and create a new Label template. Click on it in the table and select the \"Label Designer\". Click on the shapes on the left bar to add them to the label canvas.\n\n## \ud83e\uddd1\u200d\ud83d\udcbb Development\n\n1. Install as editable install to your inventree installation via `pip install -e /path/to/inventree-template-editor-plugin`\n2. Enable the plugin\n3. Install js dependencies via `cd inventree_template_editor/frontend && npm ci`\n4. Enable the dev mode for the plugin to use the vite dev server (that you need to start via `npm run dev`) in the InvenTree `config.yml` via `customize.inventree_template_editor_plugin_dev: true`\n5. Restart InvenTree and start vite dev server via `npm run dev`\n",
"bugtrack_url": null,
"license": "GPL3+",
"summary": "A visual editor to build InvenTree label templates.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/wolflu05/inventree-template-editor-plugin"
},
"split_keywords": [
"inventree",
"template",
"editor",
"label"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19b2ef84861f79fa47fcc6b607d4fd277f2e6bec5c24e47a3866f9f4adea6d38",
"md5": "13d15eda9d381ebc98a1ce116522a376",
"sha256": "ea0db3619a3c936371202a91eaac77f0fdd87fc61589e82ccb3340961d81eda8"
},
"downloads": -1,
"filename": "inventree_template_editor_plugin-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "13d15eda9d381ebc98a1ce116522a376",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 211925,
"upload_time": "2024-09-19T13:05:26",
"upload_time_iso_8601": "2024-09-19T13:05:26.103690Z",
"url": "https://files.pythonhosted.org/packages/19/b2/ef84861f79fa47fcc6b607d4fd277f2e6bec5c24e47a3866f9f4adea6d38/inventree_template_editor_plugin-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf64601e9c5b1a175db87343b10070da753c0a56396d23de963ccdde1f3933e8",
"md5": "9b3527f955b23b79fc66d1cbb3d53e16",
"sha256": "c2304eac55526c2c5147a41c42fbf777c3d877144a54535d9c860aa743c48d5b"
},
"downloads": -1,
"filename": "inventree_template_editor_plugin-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9b3527f955b23b79fc66d1cbb3d53e16",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 211631,
"upload_time": "2024-09-19T13:05:27",
"upload_time_iso_8601": "2024-09-19T13:05:27.841852Z",
"url": "https://files.pythonhosted.org/packages/cf/64/601e9c5b1a175db87343b10070da753c0a56396d23de963ccdde1f3933e8/inventree_template_editor_plugin-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 13:05:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wolflu05",
"github_project": "inventree-template-editor-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "inventree-template-editor-plugin"
}