gbif_registrar.upload

Upload datasets to GBIF.

Module Contents

Functions

upload_dataset(local_dataset_id, registrations_file)

Upload a dataset to GBIF.
gbif_registrar.upload.upload_dataset(local_dataset_id, registrations_file)

Upload a dataset to GBIF.

Parameters:

  • local_dataset_id (str) – The identifier of a dataset in the EDI repository.

  • registrations_file (str) – Path of the registrations file.

Returns:

The registrations file written back to itself as a .csv.

Return type:

None

Notes

The synchronization status of the dataset is written to the registrations file. The status is True if the dataset was successfully synchronized with GBIF and False otherwise.

Print messages indicate the progress of the upload process.

This function requires authentication with GBIF. Use the load_configuration function from the authenticate module to do this.

Examples

>>> upload_dataset("edi.1.1", "registrations.csv")