# Digikey-Inventree-Integration
[![Test Results](https://github.com/EUdds/digikey-inventree-integration/actions/workflows/python-test.yaml/badge.svg?branch=main)](https://github.com/EUdds/digikey-inventree-integration/actions/workflows/python-test.yaml)
[![PyPI version](https://badge.fury.io/py/inventree_digikey_integration.svg)](https://badge.fury.io/py/inventree_digikey_integration)
A CLI to ease importing [Digikey](https://www.digikey.com/) parts into an [Inventree](https://github.com/inventree/InvenTree) instance.
## Setup
### Installation
#### Install from Pypi
`pip install inventree_digikey_integration`
#### Install from source
1. Install [poetry](https://python-poetry.org/docs/#installation)
2. Clone the repo `git clone git@github.com:EUdds/digikey-inventree-integration.git`
3. `cd digikey-inventree-integration`
4. `poetry install`
### Configuration
Create a config.ini file according to the template and specify it's location with the `-c <path>` flag
```
[DIGIKEY_API]
CLIENT_ID=
CLIENT_SECRET=
[INVENTREE_API]
URL=<URL to the inventree instance>
USER=
PASSWORD=
```
## Usage
Invoke the cli by running `import_digikey_parts`
```bash
usage: import_digikey_parts [-h] [-y] [-c CONFIG] query_numbers [query_numbers ...]
Import Digikey part numbers into InvenTree
positional arguments:
query_numbers Part number(s) to import
optional arguments:
-h, --help show this help message and exit
-y, --yes Bypass user prompts and assume "yes"
-c CONFIG, --config CONFIG
Path to config file
```
## Testing
Run the test suite by running `poetry run pytest`
Raw data
{
"_id": null,
"home_page": "https://github.com/EUdds/digikey-inventree-integration",
"name": "inventree_digikey_integration",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "inventree,digikey",
"author": "Eric Udlis",
"author_email": "udlis.eric@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4a/b2/e7d21af591bb405949c62f060a6c8ad772372e27d8c76c4640b7ba29071f/inventree_digikey_integration-0.1.2.2.tar.gz",
"platform": null,
"description": "# Digikey-Inventree-Integration\n[![Test Results](https://github.com/EUdds/digikey-inventree-integration/actions/workflows/python-test.yaml/badge.svg?branch=main)](https://github.com/EUdds/digikey-inventree-integration/actions/workflows/python-test.yaml)\n[![PyPI version](https://badge.fury.io/py/inventree_digikey_integration.svg)](https://badge.fury.io/py/inventree_digikey_integration)\n\n\nA CLI to ease importing [Digikey](https://www.digikey.com/) parts into an [Inventree](https://github.com/inventree/InvenTree) instance.\n\n## Setup\n\n### Installation\n\n#### Install from Pypi\n\n`pip install inventree_digikey_integration`\n\n#### Install from source\n\n1. Install [poetry](https://python-poetry.org/docs/#installation)\n2. Clone the repo `git clone git@github.com:EUdds/digikey-inventree-integration.git`\n3. `cd digikey-inventree-integration`\n4. `poetry install`\n\n### Configuration\n\nCreate a config.ini file according to the template and specify it's location with the `-c <path>` flag\n\n```\n[DIGIKEY_API]\nCLIENT_ID=\nCLIENT_SECRET=\n\n[INVENTREE_API]\nURL=<URL to the inventree instance>\nUSER=\nPASSWORD=\n```\n\n\n## Usage\n\nInvoke the cli by running `import_digikey_parts`\n\n```bash\nusage: import_digikey_parts [-h] [-y] [-c CONFIG] query_numbers [query_numbers ...]\n\nImport Digikey part numbers into InvenTree\n\npositional arguments:\n query_numbers Part number(s) to import\n\noptional arguments:\n -h, --help show this help message and exit\n -y, --yes Bypass user prompts and assume \"yes\"\n -c CONFIG, --config CONFIG\n Path to config file\n```\n\n## Testing\n\nRun the test suite by running `poetry run pytest`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI to import Digikey parts into an Inventree instance",
"version": "0.1.2.2",
"project_urls": {
"Homepage": "https://github.com/EUdds/digikey-inventree-integration",
"Repository": "https://github.com/EUdds/digikey-inventree-integration"
},
"split_keywords": [
"inventree",
"digikey"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95aed8e089c098f594f4f0f22fce85dc222e76a757601cc405523bd38c269ea5",
"md5": "15c691dfd0d3aa458e313a3dddc652d8",
"sha256": "72e855d433fe7cc19b5968d6a99d46770000e6a666a5a2b7dbf03b214008bc6d"
},
"downloads": -1,
"filename": "inventree_digikey_integration-0.1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15c691dfd0d3aa458e313a3dddc652d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8913,
"upload_time": "2023-12-22T22:14:33",
"upload_time_iso_8601": "2023-12-22T22:14:33.318944Z",
"url": "https://files.pythonhosted.org/packages/95/ae/d8e089c098f594f4f0f22fce85dc222e76a757601cc405523bd38c269ea5/inventree_digikey_integration-0.1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ab2e7d21af591bb405949c62f060a6c8ad772372e27d8c76c4640b7ba29071f",
"md5": "a00172b540ded6213b9901535719bceb",
"sha256": "40d55f8fbe5c871d48b07990213982aaa43ef2198fbb6ca5a3e81b8d9afe13ef"
},
"downloads": -1,
"filename": "inventree_digikey_integration-0.1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "a00172b540ded6213b9901535719bceb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 6446,
"upload_time": "2023-12-22T22:14:34",
"upload_time_iso_8601": "2023-12-22T22:14:34.239975Z",
"url": "https://files.pythonhosted.org/packages/4a/b2/e7d21af591bb405949c62f060a6c8ad772372e27d8c76c4640b7ba29071f/inventree_digikey_integration-0.1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-22 22:14:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EUdds",
"github_project": "digikey-inventree-integration",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "inventree_digikey_integration"
}