Added docs to create a custom config class. Updated README.md to reflect new changes. Added the configurations to __init__ for importing digikey. Minor message fix

Author: Electro707

README.md

@@ -15,10 +15,6 @@ manufacturers overlap other manufacturer part numbers.
 ## 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
@@ -39,59 +35,47 @@ structure of the Sandbox API response will be a representation of what to expect
 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'
+dk_config = digikey.DigikeyJsonConfig(file_name='dk_conf.json')
+dk_config.set('client-id', 'ENTER_CLIENT_ID')
+dk_config.set('client-secret', 'ENTER_CLIENT_SECRET')
+
+dk_api = digikey.DigikeyAPI(dk_config, is_sandbox=False)
 
 # Query product number
 dkpn = '296-6501-1-ND'
-part = digikey.product_details(dkpn)
+part = dk_api.product_details(dkpn)
 
 # Search for parts 
 search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10)
-result = digikey.keyword_search(body=search_request)
+result = dk_api.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)
-```
+## API Configuration Storage
+`DigikeyAPI` requires a configuration class that will handle getting, storing, and saving key-value pairs. Currently
+only `DigikeyJsonConfig` is implemented for storing settings in a JSON file, but a custom configuration can be created.
+See [docs/DigikeyBaseConfig.md](docs/DigikeyBaseConfig.md) for more details on that.
 
 ## 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()`
+* `DigikeyAPI.keyword_search()`
+* `DigikeyAPI.product_details()`
+* `DigikeyAPI.digi_reel_pricing()`
+* `DigikeyAPI.suggested_parts()`
+* `DigikeyAPI.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()`
+* `DigikeyAPI.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()`
+* `DigikeyAPI.salesorder_history()`
+* `DigikeyAPI.status_salesorder_id()`
 
 #### Barcode
 TODO
@@ -103,7 +87,7 @@ It is possible to retrieve the number of max requests and current requests by pa
 ```python
 api_limit = {}
 search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10)
-result = digikey.keyword_search(body=search_request, api_limits=api_limit)
+result = dk_api.keyword_search(body=search_request, api_limits=api_limit)
 ```
 
 The dict will be filled with the information returned from the API:
@@ -114,3 +98,4 @@ The dict will be filled with the information returned from the API:
 }
 ```
 Sometimes the API does not return any rate limit data, the values will then be set to None.
+

digikey/__init__.py

@@ -1,6 +1,7 @@
 import logging
 from digikey.v2.api import (search, part)
 from digikey.v3.api import DigikeyAPI
+from digikey.configfile import (DigikeyBaseConfig, DigikeyJsonConfig)
 
 logger = logging.getLogger(__name__)
 

digikey/oauth/oauth2.py

@@ -132,8 +132,8 @@ def __init__(self,
         if not a_id or not a_secret:
             raise ValueError(
                 'CLIENT ID and SECRET must be set. '
-                'Set "DIGIKEY_CLIENT_ID" and "DIGIKEY_CLIENT_SECRET" '
-                'as an environment variable, or pass your keys directly to the client.'
+                'Set "client-id" and "client-secret" '
+                'in the configuration constructor.'
             )
 
         self._id = a_id

docs/DigikeyBaseConfig.md

@@ -0,0 +1,51 @@
+# Digikey-API Settings Storage Configuration
+
+The `DigikeyAPI` class of the V3 API must be given a configuration class as one of it's arguments. 
+The purpose of this configuration class is to determine how the API will store some settings like the client-id, client-secret, and other stuff. 
+
+As of right now, there is only 1 available configuration class which is `DigikeyJsonConfig`. Of course you can create your own configurator class and input that into `DigikeyAPI`, for example if you want the API to store it's configuration in a database.
+
+## DigikeyJsonConfig
+
+This configuration classes stores the API settings in a JSON file. When initializing this class, a file name/path must be given.
+
+Example:
+```python
+dk_config = digikey.DigikeyJsonConfig(file_name='test_conf.json')
+dk_config.set('client-id', 'ENTER_CLIENT_ID')
+dk_config.set('client-secret', 'ENTER_CLIENT_SECRET')
+```
+
+## Create your own storage configuration
+
+You can create your own storage configurator as mentioned to define how to store the API's settings. The `DigikeyBaseConfig` class can be inherited to create it. You must override and define 3 functions:
+
+- save(self): This function gets called when the API wants to save the settings.
+- get(self, key: str): This function gets called when the API wants to retrieve a value for a given key. Return `None` if it doesn't exist
+- set(self, key: str, val: str): This function gets called when the API wants to store a value for a given key.
+
+As an example, this is how `DigikeyJsonConfig` is implemented:
+```python
+    class DigikeyJsonConfig(DigikeyBaseConfig):
+        def __init__(self, file_name):
+            super().__init__()
+            self.file_name = file_name
+            # Get config from file if it exists
+            if os.path.exists(self.file_name):
+                with open(self.file_name, 'r') as f:
+                    self.config = json.load(f)
+            else:
+                self.config = {}
+        
+        def save(self):
+            with open(self.file_name, 'w') as f:
+                json.dump(self.config, f)
+        
+        def get(self, key: str):
+            if key in self.config:
+                return self.config[key]
+            return None
+        
+        def set(self, key: str, val: str):
+            self.config[key] = val
+```