:py:mod:`gbif_registrar.upload`
===============================

.. py:module:: gbif_registrar.upload

.. autoapi-nested-parse::

   Upload datasets to GBIF.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   gbif_registrar.upload.upload_dataset



.. py:function:: upload_dataset(local_dataset_id, registrations_file)

   Upload a dataset to GBIF.

   :param local_dataset_id: The identifier of a dataset in the EDI repository.
   :type local_dataset_id: str
   :param registrations_file: Path of the registrations file.
   :type registrations_file: str

   :returns: The registrations file written back to itself as a .csv.
   :rtype: None

   .. rubric:: 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.

   .. rubric:: Examples

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