Usage

Access to FAIRsharing via its API.

See also

https://beta.fairsharing.org/API_doc

ensure_fairsharing(force_download=False, use_tqdm=True, **kwargs)

Get the FAIRsharing registry.

Return type

Path

load_fairsharing(force_download=False, use_tqdm=True, **kwargs)

Get the FAIRsharing registry.

class FairsharingClient(login=None, password=None, base_url=None)

A client for programmatic access to the FAIRsharing private API.

Instantiate the client and get an appropriate JWT token.

Parameters

• login (Optional[str]) – FAIRsharing username

• password (Optional[str]) – Corresponding FAIRsharing password

• base_url (Optional[str]) – The base URL

get_jwt()

Get the JWT.

Return type

str

iter_records()

Iterate over all FAIRsharing records.

Return type

Iterable[Mapping[str, Any]]