Usage

Access to FAIRsharing via its API.

See also

https://beta.fairsharing.org/API_doc

class FairsharingClient(login: str | None = None, password: str | None = None, base_url: str | None = None)

A client for programmatic access to the FAIRsharing private API.

Instantiate the client and get an appropriate JWT token.

Parameters:

• login – FAIRsharing username

• password – Corresponding FAIRsharing password

• base_url – The base URL

get_jwt() → str

Get the JWT.

iter_records() → Iterable[MutableMapping[str, Any]]

Iterate over all FAIRsharing records.

ensure_fairsharing(force_download: bool = False, use_tqdm: bool = True, **kwargs: Any) → Path

Get the FAIRsharing registry.

get_fairsharing_to_orcids() → dict[str, set[str]]

Get links from FAIRsharing IDs to sets of ORCID ids for people working on/credited.

load_fairsharing(force_download: bool = False, use_tqdm: bool = True, **kwargs: Any) → Any

Get the FAIRsharing registry.