configReaders 25.7.1__py3-none-any.whl

configReaders/__init__.py

@@ -0,0 +1 @@
+from .readers import (read_config, read_json)

configReaders/readers.py

@@ -0,0 +1,38 @@
+import configparser
+import json
+
+# use this for .cfg or .ini files
+def read_config(file_path):
+    """
+    Read from .cfg file
+
+    Parameters
+    ----------
+    file_path (str) : the path to the config file
+
+    Returns
+    -------
+    see configparser docstring
+    """
+    config = configparser.ConfigParser()
+    config.read(file_path)
+    return config
+
+
+
+
+def read_json(file_path):
+    """
+    Reads .json files
+
+    Parameters
+    ----------
+    file_path (str) : the path to the json file
+
+    Returns
+    --------
+    f (dict) : dictionary
+
+    """
+    with open(file_path, 'r') as f:
+        return json.load(f)

configreaders-25.7.1.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: configReaders
+Version: 25.7.1
+Summary: Helper functions for reading keys from JSON and config files
+Author: T. Werstlein
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+#configHelpers
+_I wrote configHelpers to read .cfg, .ini or .json files that contain my api keys and passwords.
+I found that I was recreating the same functions to perform these takes in multiple scripts and
+decided to use this as a learning moment to dive into packages.
+
+##configReaders
+This is the package that contains readers.py.
+
+##Readers.py
+There are methods: read_config and read_json.
+
+###read_config
+The read_config method takes in a path to an .cfg or .ini file.
+The .cfg or .ini sould be formatted into sections with your api keys and passwords.
+How you segregate your keys and passwords is up to you, it is your .cfg or .ini after all.
+
+-- usage example:
+config_path = "default.cfg"
+myKeys = read_config(config_path)
+
+for key, value in myKeys['api_keys'].items():
+    print(key + ': ' + value)
+
+print(myKeys['api_keys']['my_key'])
+
+###read_json
+The read_json method takes in a path to a .json file.
+The .json file should be formatted into a dictionary of key/value sets.
+
+-- usage example:
+json_path = "openAI.json"
+DB = read_json(json_path)
+print(DB['KEYS']['api_key'])
+
+
+-- config (.cfg) example:
+    [keys]
+    api_key1 = key_string1
+    api_key2 = key_string2
+    exit_keys = q, Q, exit, EXIT, quit, QUIT
+    
+    [passwords]
+    api_pword1 = pass_string1
+    api_pword2 = pass_string2
+
+-- json (.json) example:
+{
+    'api1':{
+        'api_key': 'key_string',
+        'api_pass': 'pass_string',
+    }
+    'api2':{
+        'api_key': 'key_string',
+        'api_pass': 'pass_string',
+    }
+}

configreaders-25.7.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+configReaders/__init__.py,sha256=LhDqJ1yeoinK_mexynr7G1xEacuvyYT8c-3OUswWiO0,45
+configReaders/readers.py,sha256=Ebrt5ajMSdElerow2HAZOICxK-SPyC4d5T02LwwNIn8,660
+configreaders-25.7.1.dist-info/METADATA,sha256=K76tPixqp2Eb8kCIxZ_rPsdjes1p0oTezaLcZti1rvo,2005
+configreaders-25.7.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+configreaders-25.7.1.dist-info/top_level.txt,sha256=4MCMZTsHGlBfeMIp6G1XnQz-U_1MU4Wxiv0bR5B-u3g,14
+configreaders-25.7.1.dist-info/RECORD,,

configreaders-25.7.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

configreaders-25.7.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+configReaders