Add python install instructions. Add file support as input

Author: Lyetenth

doc/images/1.1.1.png

@@ -21,13 +21,12 @@ def get_detail(self, fsids, csv=False, limit=100):
         returns a list of Adaptation Detail objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make
         Returns:
             A list of Adaptation Detail
         """
-
         # Get data from api and create objects
         api_datas = self.call_api(fsids, "adaptation", "detail", None, limit=limit)
         product = [AdaptationDetail(api_data) for api_data in api_datas]
@@ -42,7 +41,7 @@ def get_summary(self, fsids, location_type, csv=False, limit=100):
         returns a list of Adaptation Summary objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             location_type (str): The location lookup type
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make

doc/images/1.1.2.png

@@ -5,7 +5,10 @@
 import asyncio
 
 # Internal Imports
+import os
+
 from firststreet.errors import InvalidArgument
+from firststreet.util import read_fsid_file
 
 
 class Api:
@@ -25,14 +28,19 @@ def call_api(self, fsids, product, product_subtype, location, limit=100):
         Street Foundation API.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             product (str): The overall product to call
             product_subtype (str): The product subtype (if suitable)
             location (str/None): The location lookup type (if suitable)
             limit (int): max number of connections to make
         Returns:
             A list of JSON responses
         """
+        if not isinstance(fsids, list):
+            if os.path.isfile(fsids):
+                fsids = read_fsid_file(fsids)
+            else:
+                raise InvalidArgument("File provided is not a list or a valid file. Please check the file name.")
 
         if not fsids:
             raise InvalidArgument(fsids)

doc/images/1.1.3.png

@@ -19,7 +19,7 @@ def get_precipitation(self, fsids, csv=False, limit=100):
         and returns a list of Environmental Precipitation objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make
         Returns:

doc/images/1.1.4.png

@@ -20,7 +20,7 @@ def get_nfip(self, fsids, location_type, csv=False, limit=100):
         returns a list of Fema Nfip objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             location_type (str): The location lookup type
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make

firststreet/api/adaptation.py

@@ -21,7 +21,7 @@ def get_event(self, fsids, csv=False, limit=100):
         returns a list of Historic Event objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make
         Returns:
@@ -42,7 +42,7 @@ def get_summary(self, fsids, location_type, csv=False, limit=100):
         returns a list of Historic Summary objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             location_type (str): The location lookup type
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make

firststreet/api/api.py

@@ -23,7 +23,7 @@ def get_detail(self, fsids, location_type, csv=False, limit=100):
         returns a list of Location Detail objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             location_type (str): The location lookup type
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make
@@ -79,7 +79,7 @@ def get_summary(self, fsids, location_type, csv=False, limit=100):
         returns a list of Location Summary objects.
 
         Args:
-            fsids (list): A First Street ID
+            fsids (list/file): A First Street Foundation IDs or a file of First Street Foundation IDs
             location_type (str): The location lookup type
             csv (bool): To output extracted data to a csv or not
             limit (int): max number of connections to make