Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

Commit 75676df

Browse files
committed
Update readme with screenshots
1 parent 751041a commit 75676df

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
33

44
## Installation
55
**NOTE**: This project requires [Python](https://www.python.org/downloads/) 3.6+ to run.
6+
1. Go to the Python page (https://www.python.org/downloads/) and download then install Python version 3. **Make sure that the checkbox is checked for Python to be added to the PATH**
7+
8+
![Screenshot](doc/images/1.1.1.png)
9+
10+
![Screenshot](doc/images/1.1.2.png)
11+
12+
![Screenshot](doc/images/1.1.3.png)
13+
14+
![Screenshot](doc/images/1.1.4.png)
15+
616
1. Install the source code manager [Git]
717
2. Open `git bash` and create then navigate to a new project directory
818

@@ -221,7 +231,7 @@ environmental.<method>
221231

222232
## Examples
223233
**[Reminder] Keep your API key safe, and do not share it with others!**
224-
1. Single FSID Extraction Through Client:
234+
1. Single FSID Extraction Through the Client:
225235
```python
226236
# Contents of sample.py
227237
import firststreet
@@ -234,7 +244,7 @@ environmental.<method>
234244
print(probability[0].count)
235245
```
236246

237-
2. Multiple FSIDs Extraction Through Client:
247+
2. Multiple FSIDs Extraction Through the Client:
238248
```python
239249
# Contents of sample.py
240250
import firststreet
@@ -248,7 +258,7 @@ environmental.<method>
248258
print(details[1].fsid)
249259
```
250260

251-
3. Adaptation detail Extraction to CSV Through Client:
261+
3. Adaptation detail Extraction to CSV Through the Client:
252262
```python
253263
# Contents of sample.py
254264
import firststreet
@@ -269,18 +279,32 @@ environmental.<method>
269279
29,Riverfront Park,pervious pavement,fluvial,False,500
270280
29,Riverfront Park,pervious pavement,pluvial,False,500
271281
```
282+
283+
4. Multiple FSIDs Extraction Using a File Through the Client:
284+
```python
285+
# Contents of sample.py
286+
import firststreet
287+
fs = firststreet.FirstStreet("api-key")
288+
289+
fsids = [1912000, 1979140]
290+
details = fs.location.get_detail(fsids, "property")
291+
292+
print(details[0].fsid)
293+
print(details[0].route)
294+
print(details[1].fsid)
295+
```
272296

273-
4. Single FSID Extraction to CSV Through Command Line:
297+
4. Single FSID Extraction to CSV Through the Command Line:
274298
```sh
275299
probability = fs.probability.get_depth -i 390000227)
276300
```
277301

278-
5. Multiple FSIDs Extraction to CSV Through Command Line:
302+
5. Multiple FSIDs Extraction to CSV Through the Command Line:
279303
```sh
280304
python -m firststreet -p historic.get_summary -i 1912000,1979140 -l property
281305
```
282306

283-
6. Bulk FSIDs Extraction From File to CSV Through Command Line:
307+
6. Bulk FSIDs Extraction From File to CSV Through the Command Line:
284308

285309
Content of sample.txt:
286310
```text

0 commit comments

Comments
 (0)