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

Commit 1d2b600

Browse files
committed
Add user testing feedback
1 parent 444206a commit 1d2b600

File tree

6 files changed

+60
-24
lines changed

6 files changed

+60
-24
lines changed

README.md

Lines changed: 60 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,30 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
6666
├── venv
6767
├── my_script.py
6868
69-
## Method 1: Through the Client
69+
## Method 1: Through the Command Line
7070
**[Reminder] Keep your API key safe, and do not share it with others!**
7171
72-
1. Create a new Python script and initialize a First Street Foundation API Client.
72+
1. [Required] Set an Environmental Variable with the `variable_name` as `FSF_API_KEY` and the `variable_value` with the `API_KEY`.
73+
74+
![Screenshot](doc/images/3.1.1.png)
75+
76+
![Screenshot](doc/images/3.1.2.png)
77+
78+
![Screenshot](doc/images/3.1.3.png)
79+
80+
2. Open a new console and navigate to the project directory. Next, call one of the methods described below in the `Products` section through the command line. See the `Examples` section for more examples.
81+
```sh
82+
cd /path/to/project
83+
python -m firststreet -p <product>.<product_subtype> -i <fsids> -f <file_name> -l <lookup_type>
84+
```
85+
86+
![Screenshot](doc/images/3.2.1.png)
87+
88+
89+
## Method 2: Through the Client
90+
**[Reminder] Keep your API key safe, and do not share it with others!**
91+
92+
1. Create a new Python script (by using notepad or any other text editor) and initialize a First Street Foundation API Client.
7393
```python
7494
# Contents of my_script.py
7595
import firststreet
@@ -78,34 +98,21 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
7898

7999
2. Call one of the methods described below in the `Products` section with the required arguments. See the `Examples` section for more examples.
80100
```python
81-
fs.<product>.<product_subtype>(<fsids: list>, <lookup_type: string>)
101+
fs.<product>.<product_subtype>(<fsids: list>, <lookup_type: string>, <csv: boolean>)
82102
```
83103

84104
![Screenshot](doc/images/2.2.1.png)
85105

86-
3. Run the python script.
87-
88-
![Screenshot](doc/images/2.3.1.png)
89-
90-
## Method 2: Through the Command Line
91-
**[Reminder] Keep your API key safe, and do not share it with others!**
92-
93-
1. [Required] Set an Environmental Variable with the variable_name as `FSF_API_KEY` and the variable_value with the API_KEY.
106+
OR
94107

95-
![Screenshot](doc/images/3.1.1.png)
108+
![Screenshot](doc/images/2.2.2.png)
96109

97-
![Screenshot](doc/images/3.1.2.png)
110+
![Screenshot](doc/images/2.2.3.png)
98111

99-
![Screenshot](doc/images/3.1.3.png)
112+
3. Run the python script.
113+
114+
![Screenshot](doc/images/2.3.1.png)
100115

101-
2. Open a new console and navigate to the project directory. Next, call one of the methods described below in the `Products` section through the command line. See the `Examples` section for more examples.
102-
```sh
103-
cd /path/to/project
104-
python -m firststreet -p <product>.<product_subtype> -i <fsids> -f <file_name> -l <lookup_type>
105-
```
106-
107-
![Screenshot](doc/images/3.2.1.png)
108-
109116

110117
##### Command Line Arguments:
111118

@@ -125,7 +132,7 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
125132

126133
Example: ```-f sample.txt```
127134

128-
Content of a sample text file:
135+
Content of a sample text file. Note that the file must be in the same directory as the project:
129136
```text
130137
541114211
131138
540456284
@@ -136,6 +143,35 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
136143
```
137144

138145
![Screenshot](doc/images/4.4.1.png)
146+
147+
![Screenshot](doc/images/4.4.2.png)
148+
149+
## Updating the Project to the Newest Version:
150+
If an update is made to this project, you will need to pull the changes from github and reinstall this project.
151+
152+
1. Open `git bash` and create then navigate to the existing project directory. Then navigate into the project directory, and run:
153+
154+
```git
155+
git pull
156+
```
157+
158+
If the response is `Already up to date.`, then you have the latest version of the project already.
159+
160+
![Screenshot](doc/images/6.1.1.png)
161+
162+
2. Open a new console, navigate to the project, and re-run the setup script to re-install the project:
163+
164+
```shell script
165+
cd /path/to/project
166+
167+
.\venv\Scripts\activate
168+
169+
pip install .\fsf_api_access_python\.
170+
```
171+
172+
![Screenshot](doc/images/6.1.2.png)
173+
174+
3. The project should now be updated to the newest version.
139175

140176
## CSV File Output:
141177
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).
@@ -303,7 +339,7 @@ environmental.<method>
303339

304340
4. Single FSID Extraction to CSV Through the Command Line:
305341
```sh
306-
probability = fs.probability.get_depth -i 390000227)
342+
python -m firststreet -p fs.probability.get_depth -i 390000227
307343
```
308344

309345
5. Multiple FSIDs Extraction to CSV Through the Command Line:

doc/images/2.2.2.png

9.1 KB
Loading

doc/images/2.2.3.png

23.6 KB
Loading

doc/images/4.4.2.png

26.9 KB
Loading

doc/images/6.1.1.png

17.4 KB
Loading

doc/images/6.1.2.png

91.1 KB
Loading

0 commit comments

Comments
 (0)