-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdbpy.py
More file actions
424 lines (372 loc) · 12.1 KB
/
dbpy.py
File metadata and controls
424 lines (372 loc) · 12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
# Databrary module
# Import dependencies
import requests
import pandas
import keyring
import io
#-----------------------------------------------------------------------------
def assign_constants(vb = False):
"Download Databrary contants from API"
# Check parameters
if (not(isinstance(vb, bool))):
print("vb must be Boolean.")
return('')
constants_url = "https://nyu.databrary.org/api/constants"
if vb:
print("Sending GET request to " + constants_url + "\n")
r = requests.get(constants_url)
if (r.status_code == 200):
if (type == 'all'):
return(r.content)
else:
# Convert content to data.frame
df = pandas.read_json(r.content, typ = 'series')
return(df)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#-----------------------------------------------------------------------------
# Access Databrary API to get current system stats
def get_db_stats(type = "all", vb = False):
"Current stats from Databrary API"
# Check parameters
if (not(isinstance(type, str))):
print("type must be a string.")
return('')
if (not(isinstance(vb, bool))):
print("vb must be Boolean.")
return('')
stats_activity_url = "https://nyu.databrary.org/api/activity"
if vb:
print("Sending GET request to " + stats_activity_url + "\n")
r = requests.get(stats_activity_url)
if (r.status_code == 200):
if (type == 'all'):
return(r.content)
else:
# Convert content to data.frame
df = pandas.read_json(r.content, typ = 'series')
return(df)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#-----------------------------------------------------------------------------
# login to Databrary
# TODO(ROG): Saving cookies!
def login_db(username = '', vb = False, stored_credentials = False, system_credentials = True, return_resp = False):
"Log in to Databrary"
# Check parameters
if (not(isinstance(username, str))):
print("username must be a string.")
return('')
if (not(isinstance(vb, bool))):
print("vb must be Boolean.")
return('')
if (not(isinstance(stored_credentials, bool))):
print("stored_credentials must be Boolean.")
return('')
if (not(isinstance(system_credentials, bool))):
print("system_credentials must be Boolean.")
return('')
login_url = "https://nyu.databrary.org/api/user/login"
if (stored_credentials):
if(vb):
print("Using stored credentials.")
elif (system_credentials):
if (username == ''):
print("Please enter your Databrary user ID (email).")
username = input("User ID: ")
if (keyring.get_keyring() != ''):
kl = keyring.get_password("databrary", username)
if (kl != 'None'):
pw = kl
else:
if (vb):
print("No password for user: ", username, "\n")
return('')
else:
if (vb):
print("No stored credentials for user: ", username, "\n")
return('')
else:
# Get login credentials
username = input("User ID: ")
pw = input("Password: ")
# Check login credentials
if (not(isinstance(username, str))):
print("username must be a string.")
return('')
if (not(isinstance(pw, str))):
print("Password must be a string")
return('')
# POST request
payload = {"email": username, "password": pw}
if (vb):
print("Sending GET request to ", login_url)
r = requests.post(login_url, data = payload)
if (r.status_code == 200):
print("Logged in.")
if (return_resp):
return(r.text)
else:
print("Log in failed with HTTP status " + r.status_code + "\n")
#------------------------------------------------------------------------------
def is_institution(party_id = 8, vb = False, return_JSON = False):
# Check parameters
if isinstance(party_id, list):
print("party_id must be single scalar value")
return('')
if not(isinstance(party_id, int)) or (party_id <= 0):
print("party_id must be an integer > 0")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
party_url = "https://nyu.databrary.org/api/party/" + str(party_id)
if (vb):
message(paste0("Sending GET to ", party_url))
r = requests.get(party_url)
if (r.status_code == 200):
if vb:
print("Success.")
if return_JSON:
return(r.text)
# Otherwise, convert JSON to data frame
df = pandas.read_json(r.content, typ = 'series')
return('institution' in df.index)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#------------------------------------------------------------------------------
def is_person(party_id = 7, vb = False):
r = not(is_institution(party_id = party_id, vb = vb))
return(r)
#------------------------------------------------------------------------------
def get_institution(party_id = 8, vb = False, return_JSON = False):
"Download data about an institution"
# Check parameters
if isinstance(party_id, list):
print("party_id must be single scalar value")
return('')
if not(isinstance(party_id, int)) or (party_id <= 0):
print("party_id must be an integer > 0")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
if not(isinstance(return_JSON, bool)):
print("return_JSON must be Boolean")
return('')
party_url = "https://nyu.databrary.org/api/party/" + str(party_id)
if (vb):
message(paste0("Sending GET to ", party_url))
r = requests.get(party_url)
if (r.status_code == 200):
if vb:
print("Success.")
if return_JSON:
return(r.text)
# Otherwise, convert JSON to data frame
df = pandas.read_json(r.content, typ = 'series')
if not('institution' in df.index):
print("Party ID " + party_id + " is not an institution.")
return('')
return(df)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#------------------------------------------------------------------------------
def get_person(party_id = 7, vb = False, return_JSON = False):
"Downloads metadata about a person."
# Check parameters
if isinstance(party_id, list):
print("party_id must be single scalar value")
return('')
if not(isinstance(party_id, int)) or (party_id <= 0):
print("party_id must be an integer > 0")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
if not(isinstance(return_JSON, bool)):
print("return_JSON must be Boolean")
return('')
party_url = "https://nyu.databrary.org/api/party/" + str(party_id)
if (vb):
message(paste0("Sending GET to ", party_url))
r = requests.get(party_url)
if (r.status_code == 200):
if vb:
print("Success.")
if return_JSON:
return(r.text)
# Otherwise, convert JSON to data frame
df = pandas.read_json(r.content, typ = 'series')
if not('prename' in df.index):
print("Party ID " + party_id + " is not a person.")
return('')
return(df)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#------------------------------------------------------------------------------
def download_party(party_id = 7, vb = False, return_JSON = False):
# Check parameters
if isinstance(party_id, list):
print("party_id must be single scalar value")
return('')
if not(isinstance(party_id, int)) or (party_id <= 0):
print("party_id must be an integer > 0")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
if not(isinstance(return_JSON, bool)):
print("return_JSON must be Boolean")
return('')
party_url = "https://nyu.databrary.org/api/party/" + str(party_id)
if (vb):
print("Sending GET to " + party_url)
r = requests.get(party_url)
if (r.status_code == 200):
if vb:
print("Success.")
if return_JSON:
return(r.text)
# Otherwise, convert JSON to data frame
df = pandas.read_json(r.content, typ = 'series')
return(df)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#------------------------------------------------------------------------------
def download_session_csv(vol_id = 1, to_df = True, return_response = False, vb = False):
# Parameter checking
if isinstance(vol_id, list):
stop("vol_id must have length 1.")
if not(isinstance(vol_id, int)) or (vol_id <= 0):
print("vol_id must be an integer > 0")
return('')
if not(isinstance(to_df, bool)):
print("vb must be Boolean")
return('')
if not(isinstance(return_response, bool)):
print("return_response must be Boolean")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
request_url = "https://nyu.databrary.org/volume/" + str(vol_id) + "/csv"
r = requests.get(request_url)
if (vb):
print("Sending GET to " + party_url)
if (r.status_code == 200):
if(to_df):
bytes_content = io.BytesIO(r.content)
df = pandas.read_csv(bytes_content)
return(df)
else:
return(r.content)
else:
print('Download Failed, HTTP status ' + r.status_code)
if (return_response):
return(r.status_code)
#------------------------------------------------------------------------------
def get_supported_file_types(vb = False):
"Extracts Databrary supported file types."
# Check parameters
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
c = assign_constants(vb = vb)
fts = c['format']
df = pandas.DataFrame.from_dict(fts)
return(df)
#------------------------------------------------------------------------------
def list_sessions_in_volume(vol_id = 1, vb = False):
"List the slots/sessions in a specified volume"
# Check parameters
if isinstance(vol_id, list):
print("vol_id must be single scalar value")
return('')
if not(isinstance(vol_id, int)) or (vol_id <= 0):
print("vol_id must be an integer > 0")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
vol_url = "https://nyu.databrary.org/api/volume/" + str(vol_id)
if (vb):
print("Sending GET to ", vol_url)
r = requests.get(vol_url)
if (r.status_code == 200):
if vb:
print("Success.")
df = pandas.read_json(r.content, typ = 'series')
return(df)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#------------------------------------------------------------------------------
def download_containers_records(vol_id = 2, convert_JSON = True, vb = False):
""" Download data about the containers (sessions/slots) in a given volume"""
# Check parameters
if isinstance(vol_id, list):
stop("vol_id must be a single, scalar value.")
if not(isinstance(vol_id, int)) or (vol_id <= 0):
print("vol_id must be an integer > 0")
return('')
if not(isinstance(convert_JSON, bool)):
print("vb must be Boolean")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
url_cont_rec = "https://nyu.databrary.org/api/volume/" + str(vol_id) + "?containers&records"
if (vb):
print("Sending GET to ", url_cont_rec)
r = requests.get(url_cont_rec)
if (r.status_code == 200):
if vb:
print("Success.")
if convert_JSON:
df = pandas.read_json(r.content, typ = 'series')
return(df)
else:
return(r.text)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')
#------------------------------------------------------------------------------
def get_asset_segment_range(vol_id = 1, session_id = 9807, asset_id = 1, vb = False):
# Check parameters
if isinstance(vol_id, list):
stop("vol_id must be a single, scalar value.")
if not(isinstance(vol_id, int)) or (vol_id <= 0):
print("vol_id must be an integer > 0")
return('')
if isinstance(session_id, list):
stop("session_id must be a single, scalar value.")
if not(isinstance(session_id, int)) or (session_id <= 0):
print("session_id must be an integer > 0")
return('')
if isinstance(asset_id, list):
stop("asset_id must be a single, scalar value.")
if not(isinstance(asset_id, int)) or (asset_id <= 0):
print("asset_id must be an integer > 0")
return('')
if not(isinstance(vb, bool)):
print("vb must be Boolean")
return('')
url = "https://nyu.databrary.org/api/volume/" + str(vol_id) + "/slot/" + str(session_id) + "/asset/" + str(asset_id)
if (vb):
print("Sending GET to ", url)
r = requests.get(url)
if (r.status_code == 200):
if vb:
print("Success!")
df = pandas.read_json(r.content, typ = 'series')
return(df)
else:
print("Download failed with HTTP status " + r.status_code + "\n")
return('')