bdcdata 0.0.5__tar.gz → 0.0.6__tar.gz

bdcdata-0.0.6/.gitignore

@@ -0,0 +1,4 @@
+**/__pycache__/
+.python-version
+.env
+.DS_Store

{bdcdata-0.0.5 → bdcdata-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bdcdata
-Version: 0.0.5
+Version: 0.0.6
 Summary: A tool to work with BDC data from the FCC.
 Project-URL: Homepage, https://github.com/npappin-wsu/bdc
 Project-URL: Issues, https://github.com/npappin-wsu/bdc/issues
@@ -21,6 +21,4 @@ Description-Content-Type: text/markdown
 
 This is a python module that will allow users to work with BDC data from the FCC through Python and Pandas.
 
-## Authentication
-
-TODO: Write something here.
+[Documentation](docs/index.md)

{bdcdata-0.0.5 → bdcdata-0.0.6}/README.md

@@ -2,6 +2,4 @@
 
 This is a python module that will allow users to work with BDC data from the FCC through Python and Pandas.
 
-## Authentication
-
-TODO: Write something here.
+[Documentation](docs/index.md)

bdcdata-0.0.6/docs/index.md

@@ -0,0 +1,12 @@
+# bdcdata Help
+
+## Getting started
+
+To use the BDC data you need to have an api key. To get this key log into the Broadband Data Collection System (https://bdc.fcc.gov), click on your name in the top right corner and then select "Manage API Access". This will give you back an API key to enter into an environment variable.
+
+After you have the key create a .env file in your projects base directory. There is an included example file (.env.sample).
+
+```Dotenv
+BDC_API_KEY='*API_HASH_KEY*'
+BDC_USERNAME='*EMAIL*'
+```

{bdcdata-0.0.5 → bdcdata-0.0.6}/src/bdcdata/helpers.py

@@ -68,5 +68,5 @@ class bdcCache:
 # Detect if parameter is empty. This is a placeholder for future implementation.
 # This function should be implemented to check if a parameter is empty or not.
 def isEmpty():
-    
-    pass
+    # TODO: Implement is empty detection.
+    return False

bdcdata-0.0.5/.gitignore

@@ -1,2 +0,0 @@
-**/__pycache__/
-.python-version