bdcdata 0.0.1__py3-none-any.whl

bdcdata/__init__.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Created on Feb 10 2025.
+
+@author: npappin-wsu
+@license: MIT
+
+Updated on Feb 11 2025.
+"""
+
+import logging
+import os
+from dotenv import load_dotenv # type: ignore
+
+load_dotenv()
+
+apiKey = os.getenv("BDC_API_KEY")
+username = os.getenv("BDC_USERNAME")
+
+# print(apiKey)
+
+# Configure logging
+logging.basicConfig(
+    filename="bdc.log", filemode="w", format="%(asctime)s - %(levelname)s - %(message)s"
+)
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.StreamHandler())
+logger.setLevel(logging.DEBUG)
+
+# print(logger)
+
+from .helpers import get_session
+
+session = get_session(apiKey, username)
+
+from .helpers import get_metadata, bdcCache
+
+metadata = get_metadata()
+
+from .bdc import *

bdcdata/bdc.py

@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Created on Feb 10 2025.
+
+@author: npappin-wsu
+@license: MIT
+
+Updated on Feb 11 2025.
+"""
+
+from . import logger, session, metadata, bdcCache
+import pandas as pd
+import json, zipfile, io
+from pprint import pprint
+
+# from . import config
+
+
+class availability:
+
+    def state(
+        states: int | str | list = "53",
+        technology: int | str | list = "50",
+        release: str | list = "2024-06-30",
+        cache=False,
+    ) -> pd.DataFrame:
+        logger.info("Collecting availability...")
+        logger.debug(f"State: {states}")
+        logger.debug(f"Technology: {technology}")
+        logger.debug(f"Release: {release}")
+        # TODO: Handle no data here
+        
+        if type(states) is not list:
+            states = [states]
+        if type(technology) is not list:
+            technology = [technology]
+        if type(release) is not list:
+            release = [release]
+        # TODO: Add normalization code here
+
+        # Retrieve availability data
+        availability = dict()
+        for r in release:
+            response = session.get(
+                f"https://broadbandmap.fcc.gov/api/public/map/downloads/listAvailabilityData/{r}"
+            )
+            if response.status_code != 200:
+                logger.error(f"Failed to retrieve availability data for {r}.")
+                raise Exception(f"Failed to retrieve availability data for {r}.")
+            # TODO: adding dtype hints here I think would be helpful.
+            availability[r] = pd.DataFrame.from_dict(response.json()["data"])
+        df = pd.DataFrame()
+        for r in release:
+            rlocal = availability[r]
+            items = rlocal[
+                (rlocal.category == "State")
+                & (rlocal.state_fips.isin(states))
+                & (rlocal.technology_code.isin(technology))
+            ].to_dict("records")
+            for item in items:
+                logger.debug(
+                    f"State: {item['state_name']}, Technology: {item['technology_code']}, Release: {r}"
+                )
+                # FUCK I DONT LIKE THIS
+                if cache and bdcCache.check(item["file_name"]):
+                    data = bdcCache.get(item["file_name"])
+                    logger.debug("Cache hit!")
+                    pass
+                else:
+                    response = session.get(
+                        f"https://broadbandmap.fcc.gov/api/public/map/downloads/downloadFile/availability/{item['file_id']}"
+                    )
+                    if response.status_code == 200 and cache:
+                        bdcCache.save(item["file_name"], response.content)
+                    data = response.content
+                if response.status_code != 200:
+                    logger.error(
+                        f"Failed to retrieve availability data for {item['state_name']} and {item['technology_code']} in {r}."
+                    )
+                    raise Exception(
+                        f"Failed to retrieve availability data for {item['state_name']} and {item['technology_code']} in {r}."
+                    )
+                else:
+                    zip = zipfile.ZipFile(io.BytesIO(data))
+                    localdf = pd.read_csv(
+                        zip.open(zip.filelist[0].filename)
+                    )  # , dtype=columnHints)
+                    df = pd.concat([df, localdf], ignore_index=True)
+        logger.debug(f"State: {states}, Technology: {technology}, Release: {release}")
+        return df
+
+
+def echo(message):
+    logger.info(message)
+    print(message)
+    pass
+
+
+def main():
+    logger.info("Starting the application...")
+    # Your code here
+
+
+if __name__ == "__main__":
+    main()

bdcdata/helpers.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Created on Feb 10 2025.
+
+@author: npappin-wsu
+@license: MIT
+
+Updated on Feb 11 2025.
+"""
+
+from . import logger
+import json, pathlib
+
+from requests_ratelimiter import LimiterSession # type: ignore
+
+
+def get_session(apiKey, username, cache=False):
+    session = LimiterSession(max_retries=3, per_minute=10)
+    session.headers.update({"User-Agent": "python-bdc"})
+    session.headers.update({"hash_value": apiKey})
+    session.headers.update({"username": username})
+    logger.debug(session.headers)
+    logger.info("Session created.")
+    return session
+
+
+def get_metadata():
+    from . import session
+
+    logger.info("Collecting metadata...")
+    r = session.get("https://broadbandmap.fcc.gov/api/public/map/listAsOfDates")
+    logger.debug(r.json())
+    parsed = json.loads(r.text)
+    logger.debug(parsed)
+    logger.debug(parsed["data"])
+    logger.info("Metadata collected.")
+    types = set([item["data_type"] for item in parsed["data"]])
+    metadata = {}
+    for t in types:
+        if t not in metadata.keys():
+            metadata[t] = list()
+        for item in parsed["data"]:
+            if item["data_type"] == t:
+                logger.debug(f"Data type: {t}")
+                logger.debug(item)
+                metadata[t].append(item["as_of_date"])
+    return metadata
+
+class bdcCache:
+    def check(filename):
+        if pathlib.Path('cache', f'{filename}.zip').exists():
+            return True
+        else:
+            return False
+        
+    def save(filename, data):
+        if not pathlib.Path('cache').exists():
+            pathlib.Path('cache').mkdir(parents=True, exist_ok=True)
+        with open(pathlib.Path('cache', f'{filename}.zip'), 'wb')as f:
+            f.write(data)
+        pass
+    
+    def get(filename):
+        with open(pathlib.Path('cache', f'{filename}.zip'), 'rb') as f:
+            return f.read()
+
+
+def isEmpty() -> bool:
+    pass

bdcdata-0.0.1.dist-info/METADATA

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: bdcdata
+Version: 0.0.1
+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
+Author-email: "W. Nick Pappin" <nick.pappin@wsu.edu>
+Maintainer-email: "W. Nick Pappin" <npappin@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Requires-Dist: pandas>=2
+Requires-Dist: python-dotenv
+Requires-Dist: requests-ratelimiter
+Description-Content-Type: text/markdown
+
+# BDC
+
+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.

bdcdata-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+bdcdata/__init__.py,sha256=E449upcky-fr91wgOe6zZmZvfh4XPs3NM8ktCF_oTKM,744
+bdcdata/bdc.py,sha256=x1HTy43arIFSgl5ibpQwMfCR-Pfnpw_SsokCKYkt2t8,3720
+bdcdata/helpers.py,sha256=QMwQAW7iAyOtF-CfxlCFm6ci2PZ9HgpS3u_NBlgfxDc,1930
+bdcdata-0.0.1.dist-info/METADATA,sha256=qmvDq5CRankRGiqk4kd-R5KLUBaZhp_V_wM-2lOAxDY,843
+bdcdata-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bdcdata-0.0.1.dist-info/licenses/LICENSE.txt,sha256=XRRBPm03M10yh16ZEzUI1fWz-1rbmawyBrQpykU15Q8,1071
+bdcdata-0.0.1.dist-info/RECORD,,

bdcdata-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

bdcdata-0.0.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025, W. Nick Pappin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.