Python client for Digikey API
Project description
Python Client for 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.
What does it do
digikey-api
is an Digkey Part Search API 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
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. 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.
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
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)
Top-level API
Product Information
Currently all functions from the PartSearch API have been implemented.
digikey.keyword_search()
digikey.product_details()
digikey.digi_reel_pricing()
digikey.suggested_parts()
digikey.manufacturer_product_details()
Order Support
TODO
Barcode
TODO
API V2 [Deprecated]
NOTE: API V2 is not supported anymore by Digi-Key and you cannot register new applications
See API V3 above to use the new API.
Register
Register an app on the Digikey API portal: Digi-Key API V2. 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.
Use
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.
import os
import digikey
os.environ['DIGIKEY_CLIENT_ID'] = 'client_id'
os.environ['DIGIKEY_CLIENT_SECRET'] = 'client_secret'
os.environ['DIGIKEY_STORAGE_PATH'] = 'cache_dir'
dkpn = '296-6501-1-ND'
part = digikey.part(dkpn)
print(part)
# <Part mpn=NE555DR>
print(part.manufacturer)
# 'Texas Instruments'
Test
python -m pytest --cov=digikey --doctest-modules --ignore=setup.py
python -m mypy digikey --ignore-missing-imports
Top-level API
digikey.search()
digikey.part()
Data models
digikey.models.KeywordSearchResult
digikey.models.Part
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for digikey_api-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 591ef340faa50ba3147e2adf162ed03517efc0932b391b8f4903c85743ddb840 |
|
MD5 | 1e60934fff07170d61952fe6cf085572 |
|
BLAKE2b-256 | e189d90648fad2cab0624835d0612c177931fe4fb71728c501c61f647f648b02 |