inventree-lectronz


Nameinventree-lectronz JSON
Version 1.0 PyPI version JSON
download
home_pageNone
SummaryLectronz integration for InvenTree
upload_time2024-04-07 23:06:58
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords inventree inventree-lectronz inventree-plugin lectronz
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pypi](https://img.shields.io/pypi/v/inventree-lectronz)](https://pypi.org/project/inventree-lectronz/)
[![python](https://img.shields.io/badge/Python-3.8+-blue)](https://www.python.org/)
[![mit](https://img.shields.io/badge/license-MIT-lightgrey)](LICENSE)

# InvenTree Lectronz

This InvenTree plugin integrates the [Lectronz](https://lectronz.com/) marketplace into
InvenTree.

## Features

- [x] **Automatic order synchronization**<br>
  *For each new Lectronz order the plugin will automatically create a InvenTree Sales Order.*
- [x] **Automatic order fulfillment**<br>
  *Lectronz orders will be automatically fulfilled if you complete a Sales Order Shipment.*
- [ ] **Automatic stock synchronization**<br>
  *Not possible yet, see [`lektronz-marketplace#33`](https://github.com/omzlo/lektronz-marketplace/issues/33).*

## Installation

Available via pypi: [`inventree-lectronz`](https://pypi.org/project/inventree-lectronz/)

1. Install the plugin according to the
   [Plugin Installation Instructions](https://docs.inventree.org/en/latest/extend/plugins/install/).
2. The plugin requires **Schedule**, **Event**, **URL**, **Navigation** and **App** integrations
   to function correctly. Enable all these integrations under `Settings -> Plugins`.

## Usage

### Initial Setup

Navigate to the plugin settings under `Settings -> Marketplace Integration - Lectronz` and
enter your **Lectronz API Token**. Also set the **Lectronz Company** to the company which acts
as the customer for all Lectronz orders.

### Linking Products

For proper stock tracking you will have to link a **Salable InvenTree Part** to each of your
Lectronz Products.

1. Go to the Part page in Inventree.<br>
   (There should be a new **Lectronz Product** Panel (this will only show up if the Part is
   marked **Salable**.)
2. Select the Lectronz Product (and any product options) you want to link the Part to.

Example:

![Example of the Lectronz Product Panel](images/link_product.png)

Note: Unlinked products will still appear in your Sales Orders, but you won't be able to
allocate Stock to them. You can link a product later and update the Sales Order though.

### Fulfilling Orders

Lectronz Orders will be automatically fulfilled once you complete a Shipment for a Sales Order.

Note: If the order requires a tracking number you have to provide it in the Shipment
information. (You can optionally also include a tracking link).

Example:

![Example of a Shipment which will automatically fulfill an order](images/shipment.png)

## Credits

- [InvenTree](https://inventree.org/) ([@SchrodingersGat](https://github.com/SchrodingersGat)
  and [@matmair](https://github.com/matmair))<br>
  This project wouldn't exist without their brilliant work on creating the awesome open-source
  inventory management solution.

- [Lectronz](https://lectronz.com/) ([@omzlo](https://github.com/omzlo))<br>
  The marketplace for makers and open-source hardware.

## License

- This project is licensed under the [MIT](LICENSE) license.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "inventree-lectronz",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "inventree, inventree-lectronz, inventree-plugin, lectronz",
    "author": null,
    "author_email": "Bobbe <mail@30350n.de>",
    "download_url": "https://files.pythonhosted.org/packages/8a/5f/f79ac25b160805ba9535174273717ec17240f09671eea838be18ce2d244b/inventree_lectronz-1.0.tar.gz",
    "platform": null,
    "description": "[![pypi](https://img.shields.io/pypi/v/inventree-lectronz)](https://pypi.org/project/inventree-lectronz/)\n[![python](https://img.shields.io/badge/Python-3.8+-blue)](https://www.python.org/)\n[![mit](https://img.shields.io/badge/license-MIT-lightgrey)](LICENSE)\n\n# InvenTree Lectronz\n\nThis InvenTree plugin integrates the [Lectronz](https://lectronz.com/) marketplace into\nInvenTree.\n\n## Features\n\n- [x] **Automatic order synchronization**<br>\n  *For each new Lectronz order the plugin will automatically create a InvenTree Sales Order.*\n- [x] **Automatic order fulfillment**<br>\n  *Lectronz orders will be automatically fulfilled if you complete a Sales Order Shipment.*\n- [ ] **Automatic stock synchronization**<br>\n  *Not possible yet, see [`lektronz-marketplace#33`](https://github.com/omzlo/lektronz-marketplace/issues/33).*\n\n## Installation\n\nAvailable via pypi: [`inventree-lectronz`](https://pypi.org/project/inventree-lectronz/)\n\n1. Install the plugin according to the\n   [Plugin Installation Instructions](https://docs.inventree.org/en/latest/extend/plugins/install/).\n2. The plugin requires **Schedule**, **Event**, **URL**, **Navigation** and **App** integrations\n   to function correctly. Enable all these integrations under `Settings -> Plugins`.\n\n## Usage\n\n### Initial Setup\n\nNavigate to the plugin settings under `Settings -> Marketplace Integration - Lectronz` and\nenter your **Lectronz API Token**. Also set the **Lectronz Company** to the company which acts\nas the customer for all Lectronz orders.\n\n### Linking Products\n\nFor proper stock tracking you will have to link a **Salable InvenTree Part** to each of your\nLectronz Products.\n\n1. Go to the Part page in Inventree.<br>\n   (There should be a new **Lectronz Product** Panel (this will only show up if the Part is\n   marked **Salable**.)\n2. Select the Lectronz Product (and any product options) you want to link the Part to.\n\nExample:\n\n![Example of the Lectronz Product Panel](images/link_product.png)\n\nNote: Unlinked products will still appear in your Sales Orders, but you won't be able to\nallocate Stock to them. You can link a product later and update the Sales Order though.\n\n### Fulfilling Orders\n\nLectronz Orders will be automatically fulfilled once you complete a Shipment for a Sales Order.\n\nNote: If the order requires a tracking number you have to provide it in the Shipment\ninformation. (You can optionally also include a tracking link).\n\nExample:\n\n![Example of a Shipment which will automatically fulfill an order](images/shipment.png)\n\n## Credits\n\n- [InvenTree](https://inventree.org/) ([@SchrodingersGat](https://github.com/SchrodingersGat)\n  and [@matmair](https://github.com/matmair))<br>\n  This project wouldn't exist without their brilliant work on creating the awesome open-source\n  inventory management solution.\n\n- [Lectronz](https://lectronz.com/) ([@omzlo](https://github.com/omzlo))<br>\n  The marketplace for makers and open-source hardware.\n\n## License\n\n- This project is licensed under the [MIT](LICENSE) license.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Lectronz integration for InvenTree",
    "version": "1.0",
    "project_urls": {
        "Homepage": "https://github.com/30350n/inventree_lectronz"
    },
    "split_keywords": [
        "inventree",
        " inventree-lectronz",
        " inventree-plugin",
        " lectronz"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e0d50e2000cb623fdb381d737d7b97ec25a0849b0df9212c1830fa7dfec612ff",
                "md5": "31e16a0c381351fcbfc400c63ba5bf4a",
                "sha256": "1f06bb9a81fd0e3a0db868c63b08593e196d6a5a64ba60b2599a67b1bfb0272e"
            },
            "downloads": -1,
            "filename": "inventree_lectronz-1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "31e16a0c381351fcbfc400c63ba5bf4a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 15951,
            "upload_time": "2024-04-07T23:06:56",
            "upload_time_iso_8601": "2024-04-07T23:06:56.473279Z",
            "url": "https://files.pythonhosted.org/packages/e0/d5/0e2000cb623fdb381d737d7b97ec25a0849b0df9212c1830fa7dfec612ff/inventree_lectronz-1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8a5ff79ac25b160805ba9535174273717ec17240f09671eea838be18ce2d244b",
                "md5": "d33d1d6ea53c8676fca38c72b8969f89",
                "sha256": "1828893c18714793a4d2d3f03a9d8cc0e54e4650f91765d025cee0d5cef42951"
            },
            "downloads": -1,
            "filename": "inventree_lectronz-1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d33d1d6ea53c8676fca38c72b8969f89",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 210408,
            "upload_time": "2024-04-07T23:06:58",
            "upload_time_iso_8601": "2024-04-07T23:06:58.435951Z",
            "url": "https://files.pythonhosted.org/packages/8a/5f/f79ac25b160805ba9535174273717ec17240f09671eea838be18ce2d244b/inventree_lectronz-1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-07 23:06:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "30350n",
    "github_project": "inventree_lectronz",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "inventree-lectronz"
}
        
Elapsed time: 0.21907s