You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 18, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+60-24Lines changed: 60 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,10 +66,30 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
66
66
├── venv
67
67
├── my_script.py
68
68
69
-
## Method 1: Through the Client
69
+
## Method 1: Through the Command Line
70
70
**[Reminder] Keep your API key safe, and do not share it with others!**
71
71
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
+

75
+
76
+

77
+
78
+

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.
**[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
94
107
95
-

108
+

96
109
97
-

110
+

98
111
99
-

112
+
3. Run the python script.
113
+
114
+

100
115
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.
@@ -125,7 +132,7 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
125
132
126
133
Example: ```-f sample.txt```
127
134
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:
129
136
```text
130
137
541114211
131
138
540456284
@@ -136,6 +143,35 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
136
143
```
137
144
138
145

146
+
147
+

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
+

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
+

173
+
174
+
3. The project should now be updated to the newest version.
139
175
140
176
## CSV File Output:
141
177
Any product above can be additionally exported to a CSV file forfurther usage if the csv boolean is set during the product call, or any call using the command line. The extracted can be foundin the `data_csv` directory of the project folder (if at least one CSV has been extracted).
@@ -303,7 +339,7 @@ environmental.<method>
303
339
304
340
4. Single FSID Extraction to CSV Through the Command Line:
305
341
```sh
306
-
probability = fs.probability.get_depth -i 390000227)
0 commit comments