Merge pull request #26 from QuantGov/clusters

0.4.4

Author: jnelson16

regcensus/__init__.py

@@ -13,6 +13,7 @@
     'list_dates',
     'list_document_types',
     'list_agencies',
+    'list_clusters',
     'list_jurisdictions',
     'list_industries'
 ]
@@ -32,6 +33,7 @@
     list_dates,
     list_document_types,
     list_agencies,
+    list_clusters,
     list_jurisdictions,
     list_industries
 )

regcensus/api.py

@@ -11,7 +11,7 @@
 
 
 def get_values(series, jurisdiction, date, documentType=None, summary=True,
-               dateIsRange=True, country=False, agency=None,
+               dateIsRange=True, country=False, agency=None, cluster=None,
                industry=None, filtered=True, industryLevel=None, version=None,
                download=False, verbose=0):
     """
@@ -84,6 +84,12 @@ def get_values(series, jurisdiction, date, documentType=None, summary=True,
     elif agency:
         url_call += f'&agency={agency}'
 
+    # If multiple clusters are given, parses the list into a string
+    if type(cluster) == list:
+        url_call += f'&cluster={",".join(str(i) for i in cluster)}'
+    elif cluster:
+        url_call += f'&cluster={cluster}'
+
     # If multiple industries are given, parses the list into a string
     if type(industry) == list:
         url_call += f'&label={",".join(str(i) for i in industry)}'
@@ -376,6 +382,17 @@ def list_agencies(jurisdictionID=None, keyword=None):
             for a in json if a["agencyName"]}.items()))
 
 
+def list_clusters():
+    """
+    Returns: dictionary containing names of clusters and associated IDs
+    """
+    url_call = URL + '/clusters'
+    json = requests.get(url_call).json()
+    return dict(sorted({
+        a["clusterName"]: a["agencyCluster"]
+        for a in json if a["clusterName"]}.items()))
+
+
 def list_jurisdictions():
     """
     Returns: dictionary containing names of jurisdictions and associated IDs

setup.py

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