Metadata-Version: 2.1
Name: digikey-api
Version: 0.3.0
Summary: Python client for Digikey API
Home-page: https://github.com/peeter123/digikey-api
Author: Peter Oostewechel
Author-email: peter_oostewechel@hotmail.com
License: GPL v3
Description: Python Client for Digikey PartSearch API v2
        =================================
        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.
        
        [![Pypi](https://img.shields.io/pypi/v/digikey-api.svg?color=brightgreen)](https://pypi.org/project/digikey-api/) 
        [![Donate](https://img.shields.io/badge/Donate-PayPal-gold.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=53HWHHVCJ3D4J&currency_code=EUR&source=url)
        
        # What does it do
        `digkey-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
        
        ## Register
        Register an app on the Digikey API portal: [Digi-Key API](https://api-portal.digikey.com/start). 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.
        
        ## Install
        ```sh
        pip install digikey-api
        
        export DIGIKEY_CLIENT_ID="client_id"
        export DIGIKEY_CLIENT_SECRET="client_secret"
        export DIGIKEY_STORAGE_PATH="cache_dir"
        ```
        
        ## 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.
        
        ```python
        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
        ```sh
        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`
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
