elm.web.osti.OstiRecord

class OstiRecord(record)

Bases: dict

Class to handle a single OSTI record as dictionary data

Parameters:

record (dict) – OSTI record in dict form, typically a response from OSTI API.

Methods

clear()
copy()
download(fp)	Download the PDF of this record
fromkeys([value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()
keys()
pop(k[,d])	If key is not found, default is returned if given, otherwise KeyError is raised
popitem()	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
strip_nested_brackets(text)	Remove text between brackets/parentheses for cleaning OSTI text
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()

Attributes

authors	Get the list of authors of this record.
date	Get the date of publication of this record
doi	Get the DOI of this record
osti_id	Get the OSTI ID of this record which is typically a 7 digit number
title	Get the title of this record
url	Get the download URL of this record
year	Get the year of publication of this record

static strip_nested_brackets(text)

Remove text between brackets/parentheses for cleaning OSTI text

property authors

Get the list of authors of this record.

Returns:

str

property title

Get the title of this record

Returns:

str | None

property year

Get the year of publication of this record

Returns:

str | None

property date

Get the date of publication of this record

Returns:

str | None

property doi

Get the DOI of this record

Returns:

str | None

property osti_id

Get the OSTI ID of this record which is typically a 7 digit number

Returns:

str | None

property url

Get the download URL of this record

Returns:

str | None

download(fp)

Download the PDF of this record

Parameters:

fp (str) – Filepath to download this record to, typically a .pdf

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, default is returned if given, otherwise KeyError is raised

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values