add documenttype arg to get_series (#20)

Author: jnelson16

regcensus/api.py

@@ -188,15 +188,15 @@ def get_reading_time(*args, **kwargs):
         'documentationUrl', 'footNote']]
 
 
-def get_series(jurisdictionID=None, verbose=0):
+def get_series(jurisdictionID=None, documentType=None, verbose=0):
     """
     Get series and date metadata for all or one specific jurisdiction
 
     Args: jurisdictionID (optional): ID for the jurisdiction
 
     Returns: pandas dataframe with the metadata
     """
-    url_call = series_url(jurisdictionID)
+    url_call = series_url(jurisdictionID, documentType)
     if verbose:
         print(f'API call: {url_call}')
     return clean_columns(json_normalize(requests.get(url_call).json()))
@@ -391,11 +391,17 @@ def list_industries(keyword=None, codeLevel=3, standard='NAICS', onlyID=False):
             i["industryName"]: i["industryID"] for i in json}.items()))
 
 
-def series_url(jurisdictionID):
+def series_url(jurisdictionID, documentType=None):
     """Gets url call for series endpoint."""
     url_call = URL + '/series'
-    if jurisdictionID:
+    if jurisdictionID and documentType:
+        url_call += (
+            f'?jurisdiction={jurisdictionID}&'
+            f'documentType={documentType}')
+    elif jurisdictionID:
         url_call += f'?jurisdiction={jurisdictionID}'
+    elif documentType:
+        url_call += f'?documentType={documentType}'
     return url_call
 
 

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name='regcensus',
-    version='0.3.0',
+    version='0.3.1',
     description='Python package for accessing data from the QuantGov API',
     url='https://github.com/QuantGov/regcensus-api-python',
     author='QuantGov',