Skip to content

Commit d0a36ea

Browse files
committed
Updated README.md to document new config related API functions
1 parent 8902345 commit d0a36ea

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,8 @@ import digikey
3939
from digikey.v3.productinformation import KeywordSearchRequest
4040

4141
dk_config = digikey.DigikeyJsonConfig(file_name='dk_conf.json')
42-
dk_config.set('client-id', 'ENTER_CLIENT_ID')
43-
dk_config.set('client-secret', 'ENTER_CLIENT_SECRET')
44-
4542
dk_api = digikey.DigikeyAPI(dk_config, is_sandbox=False)
43+
dk_api.set_client_info(client_id='ENTER_CLIENT_ID', client_secret='ENTER_CLIENT_SECRET')
4644

4745
# Query product number
4846
dkpn = '296-6501-1-ND'
@@ -60,6 +58,14 @@ See [docs/DigikeyBaseConfig.md](docs/DigikeyBaseConfig.md) for more details on t
6058

6159
## Top-level APIs
6260

61+
#### Configuration Related Functions
62+
* `set_client_info()`
63+
* Arguments are `client_id` and `client_secret`
64+
* `DigikeyAPI.needs_client_id()`
65+
* Returns `True` if a client ID is needed/missing
66+
* `DigikeyAPI.needs_client_secret()`
67+
* Returns `True` if a client secret is needed/missing
68+
6369
#### Product Information
6470
All functions from the [PartSearch](https://developer.digikey.com/products/product-information/partsearch/) API have been implemented.
6571
* `DigikeyAPI.keyword_search()`

0 commit comments

Comments
 (0)