require jurisdiction in agencies calls

Author: jnelson16

.gitignore

@@ -3,4 +3,6 @@
 *__pycache__
 build/
 dist/
-.coverage
+.coverage
+*tox*
+.python-version

README.md

@@ -1,3 +1,5 @@
+__The current version of RegCensusAPI is only compatible with Python 3.6 and newer.__
+
 # RegCensus API
 
 ## Introduction

regcensus/api.py

@@ -160,7 +160,7 @@ def get_series(seriesID=''):
     return clean_columns(output)
 
 
-def get_agencies(agencyID=''):
+def get_agencies(jurisdictionID=''):
     """
     Get metadata for all or one specific agency
 
@@ -169,7 +169,9 @@ def get_agencies(agencyID=''):
     Returns: pandas dataframe with the metadata
     """
     output = json_normalize(
-        requests.get(URL + f'/agencies/{agencyID}').json())
+        requests.get(
+            URL + (f'/agencies/jurisdiction?'
+                   f'jurisdictions={jurisdictionID}')).json())
     return clean_columns(output)
 
 
@@ -257,11 +259,12 @@ def list_series():
     return dict(sorted({s["seriesName"]: s["seriesID"] for s in json}.items()))
 
 
-def list_agencies():
+def list_agencies(jurisdictionID):
     """
     Returns: dictionary containing names of agencies and associated IDs
     """
-    json = requests.get(URL + '/agencies').json()
+    json = requests.get(
+        URL + f'/agencies/jurisdiction?jurisdictions={jurisdictionID}').json()
     return dict(sorted({
         a["agencyName"]: a["agencyID"]
         for a in json if a["agencyName"]}.items()))

tests/test_api.py

@@ -20,9 +20,9 @@ def test_get_series():
 
 
 def test_get_agencies():
-    results = rc.get_agencies()
+    results = rc.get_agencies(38)
     assert order_results(results, 'agencyID') == [
-        0, 1, 64, 65, 66, 67, 68, 69, 70, 71
+        64, 65, 66, 67, 68, 69, 70, 71, 72, 73
     ]
 
 
@@ -196,7 +196,7 @@ def test_list_series():
 
 
 def test_list_agencies():
-    results = rc.list_agencies()
+    results = rc.list_agencies(38)
     assert results['Administrative Conference of the United States'] == 195