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

Commit df925b8

Browse files
committed
Fix anchor and add ToC anchor
1 parent 4ab339d commit df925b8

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ Current release: 0.1
1010

1111
**Notice:** This API wrapper is subject to change.
1212

13+
<a name="toc"></a>
1314
# Table of contents
1415
- **[Installation](#installation)**
1516
* [Running the Project - Method 1: Through the Command Line](#method1)
1617
+ [Command Line Argument Details](#commandline)
1718
* [Running the Project - Method 2: Through the Client](#method2)
1819
- [Client Initialization Details](#client-init)
19-
- [Arguments](#client-#arguments)
20+
- [Arguments](#client-arguments)
2021
- **[Products](#products)**
2122
- [Location](#location)
2223
- [Probability](#probability)
@@ -32,7 +33,7 @@ Current release: 0.1
3233
- **[License](#license)**
3334

3435
<a name="installation"></a>
35-
# Installation
36+
# [Installation](#toc)
3637
**NOTE**: This project requires [Python](https://www.python.org/downloads/) 3.6+ to run.
3738
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**
3839

@@ -107,7 +108,7 @@ Current release: 0.1
107108
├── my_script.py
108109
109110
<a name="method1"></a>
110-
## Running the Project - Method 1: Through the Command Line
111+
## [Running the Project - Method 1: Through the Command Line](#toc)
111112
**[Reminder] Keep your API key safe, and do not share it with others!**
112113
113114
1. [Required] Set an Environmental Variable with the `variable_name` as `FSF_API_KEY` and the `variable_value` with the `API_KEY`.
@@ -127,7 +128,7 @@ Current release: 0.1
127128
![Screenshot](doc/images/3.2.1.png)
128129

129130
<a name="commandline"></a>
130-
### Command Line Argument Details:
131+
### [Command Line Argument Details:](#toc)
131132

132133
- `-p/--product PRODUCT`: [REQUIRED] The product to call from the API
133134

@@ -176,7 +177,7 @@ Current release: 0.1
176177
![Screenshot](doc/images/4.4.2.png)
177178

178179
<a name="method2"></a>
179-
## Running the Project - Method 2: Through the Client
180+
## [Running the Project - Method 2: Through the Client](#toc)
180181
**[Reminder] Keep your API key safe, and do not share it with others!**
181182

182183
1. Create a new Python script (by using notepad or any other text editor) and initialize a First Street Foundation API Client.
@@ -186,14 +187,14 @@ Current release: 0.1
186187
fs = firststreet.FirstStreet("api-key")
187188
```
188189
<a name="client-init"></a>
189-
#### Client Initialization Details
190+
#### [Client Initialization Details](#toc)
190191

191192
```python
192193
firststreet.FirstStreet(api_key, [version], [log])
193194
```
194195

195196
<a name="client-arguments"></a>
196-
#### Arguments
197+
#### [Arguments](#toc)
197198
* api_key `string`: The assigned API key to access the API.
198199
* version `string= v1`: The version of the API to access. Defaults to the current version.
199200
* log `bool= True`: Setting for whether to log info or not. Defaults to True.
@@ -216,9 +217,9 @@ Current release: 0.1
216217
![Screenshot](doc/images/2.3.1.png)
217218

218219
<a name="products"></a>
219-
# Products
220+
# [Products](#toc)
220221
<a name="location"></a>
221-
#### Location
222+
#### [Location](#toc)
222223

223224
The Location API provides `Detail` and `Summary` data for the given FSIDs.
224225

@@ -230,7 +231,7 @@ location.<method>
230231
* `get_summary`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Location Summary` product for the given IDs, location_type, and optionally creates a csv file
231232

232233
<a name="probability"></a>
233-
#### Probability
234+
#### [Probability](#toc)
234235

235236
The Probability API provides `Depth`, `Chance`, `Cumulative`, `Count` data for the given FSIDs.
236237

@@ -245,7 +246,7 @@ probability.<method>
245246
* `get_count`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Count` product for the given IDs, location_type, and optionally creates a csv file
246247

247248
<a name="historic"></a>
248-
#### Historic
249+
#### [Historic](#toc)
249250

250251
The Historic API provides `Summary` and `Event` data for the given FSIDs.
251252

@@ -257,7 +258,7 @@ historic.<method>
257258
* `get_summary`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Historic Summary` product for the given IDs, location_type, and optionally creates a csv file
258259

259260
<a name="adaptation"></a>
260-
#### Adaptation
261+
#### [Adaptation](#toc)
261262

262263
The Adaptation API provides `Summary` and `Project` data for the given FSIDs.
263264

@@ -269,7 +270,7 @@ adaptation.<method>
269270
* `get_summary`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Adaptation Summary` product for the given IDs, location_type, and optionally creates a csv file
270271

271272
<a name="fema"></a>
272-
#### Fema
273+
#### [Fema](#toc)
273274

274275
The Fema API provides `NFIP` data for the given FSIDs.
275276

@@ -280,7 +281,7 @@ fema.<method>
280281
* `get_nfip`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Fema NFIP` product for the given IDs, location_type, and optionally creates a csv file
281282

282283
<a name="environmental"></a>
283-
#### Environmental
284+
#### [Environmental](#toc)
284285

285286
The Environmental API provides `Precipitation` data for the given FSIDs.
286287

@@ -291,7 +292,7 @@ environmental.<method>
291292
* `get_precipitation`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Environmental Precipitation` product for the given county IDs, and optionally creates a csv file
292293

293294
<a name="examples"></a>
294-
# Examples
295+
# [Examples](#toc)
295296
**[Reminder] Keep your API key safe, and do not share it with others!**
296297
1. Single FSID Extraction Through the Client:
297298
```python
@@ -394,19 +395,19 @@ environmental.<method>
394395
```
395396

396397
<a name="csv-output"></a>
397-
# CSV File Output:
398+
# [CSV File Output:](#toc)
398399
Any product above can be additionally exported to a CSV file for further usage if the csv boolean is set during the product call, or any call using the command line. The extracted can be found in the `data_csv` directory of the project folder (if at least one CSV has been extracted).
399400

400401
<a name="csv-name"></a>
401-
#### CSV File Name:
402+
#### [CSV File Name:](#toc)
402403
The file name will be in the format of `YYYY_MM_DD_HH_mm_SS_product_subtype_lookup.csv`.
403404

404405
Ex:
405406
- `2020_06_10_17_29_49_adaptation_detail.csv`
406407
- `2020_06_10_17_33_56_adaptation_summary_property.csv`
407408

408409
<a name="csv-content"></a>
409-
#### CSV File Content
410+
#### [CSV File Content](#toc)
410411
The contents of the CSV file will follow similar formats as the `First Street Foundation API - V1.0 Overview and Dictionary`, but all lists will be expanded to a flat file. For any values that are null or not available, `<NA>` will be used.
411412

412413
Ex:
@@ -426,7 +427,7 @@ fsid,year,returnPeriod,bin,low,mid,high
426427
![Screenshot](doc/images/5.2.2.png)
427428

428429
<a name="updating"></a>
429-
# Updating the Project to the Newest Version:
430+
# [Updating the Project to the Newest Version:](#toc)
430431
If an update is made to this project, you will need to pull the changes from github and reinstall this project.
431432

432433
1. Open `git bash` and create then navigate to the existing project directory. Then navigate into the project directory, and run:
@@ -458,7 +459,7 @@ If an update is made to this project, you will need to pull the changes from git
458459
3. The project should now be updated to the newest version
459460

460461
<a name="license"></a>
461-
# License
462+
# [License](#toc)
462463
```
463464
MIT License
464465

0 commit comments

Comments
 (0)