diff options
Diffstat (limited to 'python-digikey-api.spec')
| -rw-r--r-- | python-digikey-api.spec | 338 |
1 files changed, 338 insertions, 0 deletions
diff --git a/python-digikey-api.spec b/python-digikey-api.spec new file mode 100644 index 0000000..b0eeee6 --- /dev/null +++ b/python-digikey-api.spec @@ -0,0 +1,338 @@ +%global _empty_manifest_terminate_build 0 +Name: python-digikey-api +Version: 1.0.0 +Release: 1 +Summary: Python client for Digikey API +License: GPL v3 +URL: https://github.com/peeter123/digikey-api +Source0: https://mirrors.aliyun.com/pypi/web/packages/64/63/6ed79fa29d1ee35610b8d9a6d6d0d22c1e984caaa67b1753bd3fc100b4f8/digikey-api-1.0.0.tar.gz +BuildArch: noarch + +Requires: python3-requests +Requires: python3-retrying +Requires: python3-inflection +Requires: python3-certauth +Requires: python3-urllib3 + +%description +Search for parts in the Digi-Key catalog by keyword using KeywordSearch. Then make a PartDetails call to retrieve all +real time information about the part including pricing. PartDetails works best with Digi-Key part numbers as some +manufacturers overlap other manufacturer part numbers. +[](https://pypi.org/project/digikey-api/) +[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=53HWHHVCJ3D4J¤cy_code=EUR&source=url) +# What does it do +`digikey-api` is an [Digkey Part Search API](https://api-portal.digikey.com/node/8517) client for Python 3.6+. API response data is returned as Python objects that attempt to make it easy to get the data you want. Not all endpoints have been implemented. +# Quickstart +## Install +```sh +pip install digikey-api +export DIGIKEY_CLIENT_ID="client_id" +export DIGIKEY_CLIENT_SECRET="client_secret" +export DIGIKEY_STORAGE_PATH="cache_dir" +``` +# API V3 +## Register +Register an app on the Digikey API portal: [Digi-Key API V3](https://developer.digikey.com/get_started). You will need +the client ID and the client secret to use the API. You will also need a Digi-Key account to authenticate, using the +Oauth2 process. +When registering an app the OAuth Callback needs to be set to `https://localhost:8139/digikey_callback`. +## Use [API V3] +Python will automatically spawn a browser to allow you to authenticate using the Oauth2 process. After obtaining a token +the library will cache the access token and use the refresh token to automatically refresh your credentials. +You can test your application using the sandbox API, the data returned from a Sandbox API may not be complete, but the +structure of the Sandbox API response will be a representation of what to expect in Production. +For valid responses make sure you use the client ID and secret for a [Production App](https://developer.digikey.com/documentation/organization) +```python +import os +import digikey +from digikey.v3.productinformation import KeywordSearchRequest +os.environ['DIGIKEY_CLIENT_ID'] = 'client_id' +os.environ['DIGIKEY_CLIENT_SECRET'] = 'client_secret' +os.environ['DIGIKEY_CLIENT_SANDBOX'] = 'False' +os.environ['DIGIKEY_STORAGE_PATH'] = 'cache_dir' +# Query product number +dkpn = '296-6501-1-ND' +part = digikey.product_details(dkpn) +# Search for parts +search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10) +result = digikey.keyword_search(body=search_request) +``` +## Logging [API V3] +Logging is not forced upon the user but can be enabled according to convention: +```python +import logging +logger = logging.getLogger(__name__) +logger.setLevel(logging.DEBUG) +digikey_logger = logging.getLogger('digikey') +digikey_logger.setLevel(logging.DEBUG) +handler = logging.StreamHandler() +handler.setLevel(logging.DEBUG) +logger.addHandler(handler) +digikey_logger.addHandler(handler) +``` +## Top-level APIs +#### Product Information +All functions from the [PartSearch](https://developer.digikey.com/products/product-information/partsearch/) API have been implemented. +* `digikey.keyword_search()` +* `digikey.product_details()` +* `digikey.digi_reel_pricing()` +* `digikey.suggested_parts()` +* `digikey.manufacturer_product_details()` +#### Batch Product Details +The one function from the [BatchProductDetailsAPI](https://developer.digikey.com/products/batch-productdetails/batchproductdetailsapi) API has been implemented. +* `digikey.batch_product_details()` +#### Order Support +All functions from the [OrderDetails](https://developer.digikey.com/products/order-support/orderdetails/) API have been implemented. +* `digikey.salesorder_history()` +* `digikey.status_salesorder_id()` +#### Barcode +TODO +## API Limits +The API has a limited amount of requests you can make per time interval [Digikey Rate Limits](https://developer.digikey.com/documentation/shared-concepts#rate-limits). +It is possible to retrieve the number of max requests and current requests by passing an optional api_limits kwarg to an API function: +```python +api_limit = {} +search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10) +result = digikey.keyword_search(body=search_request, api_limits=api_limit) +``` +The dict will be filled with the information returned from the API: +```python +{ + 'api_requests_limit': 1000, + 'api_requests_remaining': 139 +} +``` +Sometimes the API does not return any rate limit data, the values will then be set to None. + +%package -n python3-digikey-api +Summary: Python client for Digikey API +Provides: python-digikey-api +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-digikey-api +Search for parts in the Digi-Key catalog by keyword using KeywordSearch. Then make a PartDetails call to retrieve all +real time information about the part including pricing. PartDetails works best with Digi-Key part numbers as some +manufacturers overlap other manufacturer part numbers. +[](https://pypi.org/project/digikey-api/) +[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=53HWHHVCJ3D4J¤cy_code=EUR&source=url) +# What does it do +`digikey-api` is an [Digkey Part Search API](https://api-portal.digikey.com/node/8517) client for Python 3.6+. API response data is returned as Python objects that attempt to make it easy to get the data you want. Not all endpoints have been implemented. +# Quickstart +## Install +```sh +pip install digikey-api +export DIGIKEY_CLIENT_ID="client_id" +export DIGIKEY_CLIENT_SECRET="client_secret" +export DIGIKEY_STORAGE_PATH="cache_dir" +``` +# API V3 +## Register +Register an app on the Digikey API portal: [Digi-Key API V3](https://developer.digikey.com/get_started). You will need +the client ID and the client secret to use the API. You will also need a Digi-Key account to authenticate, using the +Oauth2 process. +When registering an app the OAuth Callback needs to be set to `https://localhost:8139/digikey_callback`. +## Use [API V3] +Python will automatically spawn a browser to allow you to authenticate using the Oauth2 process. After obtaining a token +the library will cache the access token and use the refresh token to automatically refresh your credentials. +You can test your application using the sandbox API, the data returned from a Sandbox API may not be complete, but the +structure of the Sandbox API response will be a representation of what to expect in Production. +For valid responses make sure you use the client ID and secret for a [Production App](https://developer.digikey.com/documentation/organization) +```python +import os +import digikey +from digikey.v3.productinformation import KeywordSearchRequest +os.environ['DIGIKEY_CLIENT_ID'] = 'client_id' +os.environ['DIGIKEY_CLIENT_SECRET'] = 'client_secret' +os.environ['DIGIKEY_CLIENT_SANDBOX'] = 'False' +os.environ['DIGIKEY_STORAGE_PATH'] = 'cache_dir' +# Query product number +dkpn = '296-6501-1-ND' +part = digikey.product_details(dkpn) +# Search for parts +search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10) +result = digikey.keyword_search(body=search_request) +``` +## Logging [API V3] +Logging is not forced upon the user but can be enabled according to convention: +```python +import logging +logger = logging.getLogger(__name__) +logger.setLevel(logging.DEBUG) +digikey_logger = logging.getLogger('digikey') +digikey_logger.setLevel(logging.DEBUG) +handler = logging.StreamHandler() +handler.setLevel(logging.DEBUG) +logger.addHandler(handler) +digikey_logger.addHandler(handler) +``` +## Top-level APIs +#### Product Information +All functions from the [PartSearch](https://developer.digikey.com/products/product-information/partsearch/) API have been implemented. +* `digikey.keyword_search()` +* `digikey.product_details()` +* `digikey.digi_reel_pricing()` +* `digikey.suggested_parts()` +* `digikey.manufacturer_product_details()` +#### Batch Product Details +The one function from the [BatchProductDetailsAPI](https://developer.digikey.com/products/batch-productdetails/batchproductdetailsapi) API has been implemented. +* `digikey.batch_product_details()` +#### Order Support +All functions from the [OrderDetails](https://developer.digikey.com/products/order-support/orderdetails/) API have been implemented. +* `digikey.salesorder_history()` +* `digikey.status_salesorder_id()` +#### Barcode +TODO +## API Limits +The API has a limited amount of requests you can make per time interval [Digikey Rate Limits](https://developer.digikey.com/documentation/shared-concepts#rate-limits). +It is possible to retrieve the number of max requests and current requests by passing an optional api_limits kwarg to an API function: +```python +api_limit = {} +search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10) +result = digikey.keyword_search(body=search_request, api_limits=api_limit) +``` +The dict will be filled with the information returned from the API: +```python +{ + 'api_requests_limit': 1000, + 'api_requests_remaining': 139 +} +``` +Sometimes the API does not return any rate limit data, the values will then be set to None. + +%package help +Summary: Development documents and examples for digikey-api +Provides: python3-digikey-api-doc +%description help +Search for parts in the Digi-Key catalog by keyword using KeywordSearch. Then make a PartDetails call to retrieve all +real time information about the part including pricing. PartDetails works best with Digi-Key part numbers as some +manufacturers overlap other manufacturer part numbers. +[](https://pypi.org/project/digikey-api/) +[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=53HWHHVCJ3D4J¤cy_code=EUR&source=url) +# What does it do +`digikey-api` is an [Digkey Part Search API](https://api-portal.digikey.com/node/8517) client for Python 3.6+. API response data is returned as Python objects that attempt to make it easy to get the data you want. Not all endpoints have been implemented. +# Quickstart +## Install +```sh +pip install digikey-api +export DIGIKEY_CLIENT_ID="client_id" +export DIGIKEY_CLIENT_SECRET="client_secret" +export DIGIKEY_STORAGE_PATH="cache_dir" +``` +# API V3 +## Register +Register an app on the Digikey API portal: [Digi-Key API V3](https://developer.digikey.com/get_started). You will need +the client ID and the client secret to use the API. You will also need a Digi-Key account to authenticate, using the +Oauth2 process. +When registering an app the OAuth Callback needs to be set to `https://localhost:8139/digikey_callback`. +## Use [API V3] +Python will automatically spawn a browser to allow you to authenticate using the Oauth2 process. After obtaining a token +the library will cache the access token and use the refresh token to automatically refresh your credentials. +You can test your application using the sandbox API, the data returned from a Sandbox API may not be complete, but the +structure of the Sandbox API response will be a representation of what to expect in Production. +For valid responses make sure you use the client ID and secret for a [Production App](https://developer.digikey.com/documentation/organization) +```python +import os +import digikey +from digikey.v3.productinformation import KeywordSearchRequest +os.environ['DIGIKEY_CLIENT_ID'] = 'client_id' +os.environ['DIGIKEY_CLIENT_SECRET'] = 'client_secret' +os.environ['DIGIKEY_CLIENT_SANDBOX'] = 'False' +os.environ['DIGIKEY_STORAGE_PATH'] = 'cache_dir' +# Query product number +dkpn = '296-6501-1-ND' +part = digikey.product_details(dkpn) +# Search for parts +search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10) +result = digikey.keyword_search(body=search_request) +``` +## Logging [API V3] +Logging is not forced upon the user but can be enabled according to convention: +```python +import logging +logger = logging.getLogger(__name__) +logger.setLevel(logging.DEBUG) +digikey_logger = logging.getLogger('digikey') +digikey_logger.setLevel(logging.DEBUG) +handler = logging.StreamHandler() +handler.setLevel(logging.DEBUG) +logger.addHandler(handler) +digikey_logger.addHandler(handler) +``` +## Top-level APIs +#### Product Information +All functions from the [PartSearch](https://developer.digikey.com/products/product-information/partsearch/) API have been implemented. +* `digikey.keyword_search()` +* `digikey.product_details()` +* `digikey.digi_reel_pricing()` +* `digikey.suggested_parts()` +* `digikey.manufacturer_product_details()` +#### Batch Product Details +The one function from the [BatchProductDetailsAPI](https://developer.digikey.com/products/batch-productdetails/batchproductdetailsapi) API has been implemented. +* `digikey.batch_product_details()` +#### Order Support +All functions from the [OrderDetails](https://developer.digikey.com/products/order-support/orderdetails/) API have been implemented. +* `digikey.salesorder_history()` +* `digikey.status_salesorder_id()` +#### Barcode +TODO +## API Limits +The API has a limited amount of requests you can make per time interval [Digikey Rate Limits](https://developer.digikey.com/documentation/shared-concepts#rate-limits). +It is possible to retrieve the number of max requests and current requests by passing an optional api_limits kwarg to an API function: +```python +api_limit = {} +search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10) +result = digikey.keyword_search(body=search_request, api_limits=api_limit) +``` +The dict will be filled with the information returned from the API: +```python +{ + 'api_requests_limit': 1000, + 'api_requests_remaining': 139 +} +``` +Sometimes the API does not return any rate limit data, the values will then be set to None. + +%prep +%autosetup -n digikey-api-1.0.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-digikey-api -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.0-1 +- Package Spec generated |