Reference / API
This part of the documentation covers all the interfaces / APIs of the pyDataverse modules.
Where pyDataverse depends on external libraries, we document the most
important right here and provide links to the canonical documentation outside of scope.
API Interface
Access all of Dataverse APIs.
Models Interface
Use all metadata models of the Dataverse data-types (Dataverse, Dataset
and Datafile). This includes import, export and manipulation.
Utils Interface
Helper functions.
Exceptions
Custom exceptions.
Find out more at https://github.com/GDCC/pyDataverse.
-
exception ApiAuthorizationError[source]
Raised if a user provides invalid credentials.
-
exception ApiResponseError[source]
Raised when the requests response fails.
-
exception ApiUrlError[source]
Raised when the request url is not valid.
-
exception DatafileNotFoundError[source]
Raised when a Datafile cannot be found.
-
exception DatasetNotFoundError[source]
Raised when a Dataset cannot be found.
-
exception DataverseApiError[source]
Base exception class for Dataverse-related api error.
-
exception DataverseError[source]
Base exception class for Dataverse-related error.
-
exception DataverseNotEmptyError[source]
Raised when a Dataverse has accessioned Datasets.
-
exception DataverseNotFoundError[source]
Raised when a Dataverse cannot be found.
-
exception OperationFailedError[source]
Raised when an operation fails for an unknown reason.