README.md

@@ -1,9 +1,4 @@
 # NANPA API Client
-
-<p align="center">
-  <img src="./.screens/nanpa.png">
-</p>
-
 A Python client for interacting with the North American Numbering Plan Administration (NANPA) public API system.
 
 ## Overview

nanpa/client.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 # North American Numbering Plan Administration (NANPA) API Client - Developed by acidvegas in Python (https://git.acid.vegas/nanpa)
-# nanpa/client.py
 
 import json
 import logging
@@ -10,211 +9,210 @@ import urllib.request
 
 
 class NanpaAPI:
-	def __init__(self):
+    def __init__(self):
-		'''Initialize the NANPA API client.'''
+        '''Initialize the NANPA API client.'''
 
-		self.base_url = 'https://api.nanpa.com/reports/public'
+        self.base_url = 'https://api.nanpa.com/reports/public'
 
+    def _make_request(self, endpoint: str, params: dict = None) -> dict:
+        '''
+        Make a request to the NANPA API.
         
-	def _make_request(self, endpoint: str, params: dict = None) -> dict:
+        :param endpoint: API endpoint to call
-		'''
+        :param params: Optional query parameters
-		Make a request to the NANPA API.
+        '''
 
-		:param endpoint: API endpoint to call
+        url = f'{self.base_url}/{endpoint}'
-		:param params: Optional query parameters
-		'''
         
-		url = f'{self.base_url}/{endpoint}'
+        if params:
+            url += '?' + urllib.parse.urlencode(params)
             
-		if params:
+        try:
-			url += '?' + urllib.parse.urlencode(params)
+            with urllib.request.urlopen(url) as response:
+                return json.loads(response.read().decode())
+        except urllib.error.URLError as e:
+            logging.error(f'Failed to make request to {url}: {e}')
+            return None
 
-		try:
-			with urllib.request.urlopen(url) as response:
-				return json.loads(response.read().decode())
-		except urllib.error.URLError as e:
-			logging.error(f'Failed to make request to {url}: {e}')
-			return None
 
+    def get_9yy_codes(self) -> dict:
+        '''Get 9YY specialty codes.'''
 
-	def get_9yy_codes(self) -> dict:
+        return self._make_request('specialityResources/9yy/codes')
-		'''Get 9YY specialty codes.'''
 
-		return self._make_request('specialityResources/9yy/codes')
 
+    def get_area_code_info(self, npa: str) -> dict:
+        '''
+        Get detailed information about a specific area code.
         
-	def get_area_code_info(self, npa: str) -> dict:
+        :param npa: Area code to lookup
-		'''
+        '''
-		Get detailed information about a specific area code.
 
-		:param npa: Area code to lookup
+        params = {'npa': npa}
-		'''
 
-		params = {'npa': npa}
+        return self._make_request('npa/areaCodeListing', params)
 
-		return self._make_request('npa/areaCodeListing', params)
 
+    def get_area_codes_by_state(self, state: str) -> dict:
+        '''
+        Get area codes for a specific state.
         
-	def get_area_codes_by_state(self, state: str) -> dict:
+        :param state: Two-letter state code
-		'''
+        '''
-		Get area codes for a specific state.
 
-		:param state: Two-letter state code
+        params = {'states': state, 'isExternal': 'false'}
-		'''
 
-		params = {'states': state, 'isExternal': 'false'}
+        return self._make_request('code/getNpasForStates', params)
 
-		return self._make_request('code/getNpasForStates', params)
 
+    def get_co_code_forecast(self, state: str, npa: str) -> dict:
+        '''
+        Get CO code forecast information.
         
-	def get_co_code_forecast(self, state: str, npa: str) -> dict:
+        :param state: Two-letter state code
-		'''
+        :param npa: Area code
-		Get CO code forecast information.
 
-		:param state: Two-letter state code
+        '''
-		:param npa: Area code
 
-		'''
+        params = {'state': state, 'npa': npa}
 
-		params = {'state': state, 'npa': npa}
+        return self._make_request('tbco/coCodeForecast', params)
 
-		return self._make_request('tbco/coCodeForecast', params)
 
+    def get_current_pool_tracking(self, state: str, npa: str) -> dict:
+        '''
+        Get current pool tracking information.
         
-	def get_current_pool_tracking(self, state: str, npa: str) -> dict:
+        :param state: Two-letter state code
-		'''
+        :param npa: Area code
-		Get current pool tracking information.
+        '''
 
-		:param state: Two-letter state code
+        params = {'state': state, 'npa': npa}
-		:param npa: Area code
-		'''
 
-		params = {'state': state, 'npa': npa}
+        return self._make_request('tbco/currentPoolTracking', params)
 
-		return self._make_request('tbco/currentPoolTracking', params)
 
+    def get_lrn_forecast(self, state: str, npa: str) -> dict:
+        '''
+        Get LRN forecast information.
         
-	def get_lrn_forecast(self, state: str, npa: str) -> dict:
+        :param state: Two-letter state code
-		'''
+        :param npa: Area code
-		Get LRN forecast information.
+        '''
 
-		:param state: Two-letter state code
+        params = {'state': state, 'npa': npa}
-		:param npa: Area code
-		'''
 
-		params = {'state': state, 'npa': npa}
+        return self._make_request('tbco/lrnForecast', params)
 
-		return self._make_request('tbco/lrnForecast', params)
 
+    def get_pooling_forecast(self, state: str, npa: str) -> dict:
+        '''
+        Get pooling forecast information.
         
-	def get_pooling_forecast(self, state: str, npa: str) -> dict:
+        :param state: Two-letter state code
-		'''
+        :param npa: Area code
-		Get pooling forecast information.
+        '''
 
-		:param state: Two-letter state code
+        params = {'state': state, 'npa': npa}
-		:param npa: Area code
-		'''
 
-		params = {'state': state, 'npa': npa}
+        return self._make_request('tbco/poolingForecast', params)
 
-		return self._make_request('tbco/poolingForecast', params)
 
+    def get_pstn_activation(self, state: str) -> dict:
+        '''
+        Get PSTN activation information.
         
-	def get_pstn_activation(self, state: str) -> dict:
+        :param state: Two-letter state code
-		'''
+        '''
-		Get PSTN activation information.
 
-		:param state: Two-letter state code
+        params = {'state': state}
-		'''
 
-		params = {'state': state}
+        return self._make_request('tbco/pstnActivation', params)
 
-		return self._make_request('tbco/pstnActivation', params)
 
+    def get_rate_center_changes(self, start_date: str, end_date: str) -> dict:
+        '''
+        Get rate center changes between two dates.
         
-	def get_rate_center_changes(self, start_date: str, end_date: str) -> dict:
+        :param start_date: Start date in format YYYY-MM-DDT00:00:00.000-05:00
-		'''
+        :param end_date: End date in format YYYY-MM-DDT23:59:59.999-05:00
-		Get rate center changes between two dates.
+        '''
 
-		:param start_date: Start date in format YYYY-MM-DDT00:00:00.000-05:00
+        params = {'startDate': start_date, 'endDate': end_date}
-		:param end_date: End date in format YYYY-MM-DDT23:59:59.999-05:00
-		'''
 
-		params = {'startDate': start_date, 'endDate': end_date}
+        return self._make_request('npa/rateCenterChanges', params)
 
-		return self._make_request('npa/rateCenterChanges', params)
 
+    def get_rate_centers(self, state: str) -> dict:
+        '''
+        Get rate centers for a specific state.
         
-	def get_rate_centers(self, state: str) -> dict:
+        :param state: Two-letter state code
-		'''
+        '''
-		Get rate centers for a specific state.
 
-		:param state: Two-letter state code
+        params = {'state': state}
-		'''
 
-		params = {'state': state}
+        return self._make_request('npa/rateCenters', params)
 
-		return self._make_request('npa/rateCenters', params)
 
+    def get_specialty_codes_aging(self) -> dict:
+        '''Get aging 5XX specialty codes.'''
 
-	def get_specialty_codes_aging(self) -> dict:
+        return self._make_request('specialityResources/5xx/aging')
-		'''Get aging 5XX specialty codes.'''
 
-		return self._make_request('specialityResources/5xx/aging')
 
+    def get_specialty_codes_assigned(self) -> dict:
+        '''Get assigned 5XX specialty codes.'''
 
-	def get_specialty_codes_assigned(self) -> dict:
+        return self._make_request('specialityResources/5xx/assigned')
-		'''Get assigned 5XX specialty codes.'''
 
-		return self._make_request('specialityResources/5xx/assigned')
 
+    def get_specialty_codes_available(self, code_type: str = '5xx') -> dict:
+        '''
+        Get available specialty codes.
         
-	def get_specialty_codes_available(self, code_type: str = '5xx') -> dict:
+        :param code_type: Code type ('5xx' or '9yy')
-		'''
+        '''
-		Get available specialty codes.
 
-		:param code_type: Code type ('5xx' or '9yy')
+        return self._make_request(f'specialityResources/{code_type}/available')
-		'''
 
-		return self._make_request(f'specialityResources/{code_type}/available')
 
+    def get_states(self) -> dict:
+        '''Get all NANPA states and territories.'''
 
-	def get_states(self) -> dict:
+        return self._make_request('nanpaStates')
-		'''Get all NANPA states and territories.'''
 
-		return self._make_request('nanpaStates')
 
+    def get_thousands_blocks(self, state: str, npa: str, report_type: str = 'AS') -> dict:
+        '''
+        Get thousands blocks information.
         
-	def get_thousands_blocks(self, state: str, npa: str, report_type: str = 'AS') -> dict:
+        :param state: Two-letter state code
-		'''
+        :param npa: Area code
-		Get thousands blocks information.
+        :param report_type: Report type (default: AS)
+        '''
 
-		:param state: Two-letter state code
+        params = {'state': state, 'npa': npa, 'reportType': report_type}
-		:param npa: Area code
-		:param report_type: Report type (default: AS)
-		'''
 
-		params = {'state': state, 'npa': npa, 'reportType': report_type}
+        return self._make_request('tbco/thousandsBlocks', params)
-
-		return self._make_request('tbco/thousandsBlocks', params)
 
 
 
 def main():
-	'''Example usage of the NANPA API client.'''
+    '''Example usage of the NANPA API client.'''
 
-	client = NanpaAPI()
+    client = NanpaAPI()
     
-	# Example API calls
+    # Example API calls
-	states = client.get_states()
+    states = client.get_states()
-	logging.info(f'States: {json.dumps(states, indent=2)}')
+    logging.info(f'States: {json.dumps(states, indent=2)}')
     
-	fl_codes = client.get_area_codes_by_state('FL')
+    fl_codes = client.get_area_codes_by_state('FL')
-	logging.info(f'Florida area codes: {json.dumps(fl_codes, indent=2)}')
+    logging.info(f'Florida area codes: {json.dumps(fl_codes, indent=2)}')
     
-	area_info = client.get_area_code_info('301')
+    area_info = client.get_area_code_info('301')
-	logging.info(f'301 area code info: {json.dumps(area_info, indent=2)}')
+    logging.info(f'301 area code info: {json.dumps(area_info, indent=2)}')
 
 
 if __name__ == '__main__':
-	main()
+    main()