configReaders 0.1.0__tar.gz

configreaders-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: configReaders
+Version: 0.1.0
+Summary: Helper functions for reading keys from JSON and config files
+Author: T. Werstlein
+License: MIT
+Keywords: config,configparser,json,helpers
+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
+
+#configReaders
+configReaders is a small helper library that reads .cfg, .ini or .json files that contain 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(file_path)
+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 = "file_name.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(file_path)
+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 = "file_name.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-0.1.0/README.md

@@ -0,0 +1,55 @@
+#configReaders
+configReaders is a small helper library that reads .cfg, .ini or .json files that contain 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(file_path)
+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 = "file_name.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(file_path)
+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 = "file_name.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-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "configReaders"
+version = "0.1.0"
+description = "Helper functions for reading keys from JSON and config files"
+keywords = ["config", "configparser", "json", "helpers"]
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "T. Werstlein" }
+]
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["configReaders*"]

configreaders-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

configreaders-0.1.0/src/configReaders/__init__.py

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

configreaders-0.1.0/src/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-0.1.0/src/configReaders.egg-info/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: configReaders
+Version: 0.1.0
+Summary: Helper functions for reading keys from JSON and config files
+Author: T. Werstlein
+License: MIT
+Keywords: config,configparser,json,helpers
+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
+
+#configReaders
+configReaders is a small helper library that reads .cfg, .ini or .json files that contain 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(file_path)
+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 = "file_name.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(file_path)
+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 = "file_name.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-0.1.0/src/configReaders.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+src/configReaders/__init__.py
+src/configReaders/readers.py
+src/configReaders.egg-info/PKG-INFO
+src/configReaders.egg-info/SOURCES.txt
+src/configReaders.egg-info/dependency_links.txt
+src/configReaders.egg-info/top_level.txt

configreaders-0.1.0/src/configReaders.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

configreaders-0.1.0/src/configReaders.egg-info/top_level.txt

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