API Docs

delma.check_eml(eml_xml='eml.xml', working_dir='./')

Checks whether or not your eml xml file is formatted correctly for GBIF.

Parameters:

• eml_xml (str) – Name of the eml xml file you want to validate. Default value is 'eml.xml'.

• working_dir (str) – Name of the directory to write the eml.xml. Default value is './'.

Return type:

Raises a ValueError if something is wrong, or returns None if it passes.

delma.create_md(metadata_md='metadata.md', working_dir='./', xml_url=None, print_notices=True)

Creates a markdown file containing the metadata information needed for the DwCA. The user can edit this markdown, and use it to generate the metadata files.

Parameters:

• metadata_md (str) – Name of the metadata file you will edit. Default is 'metadata.md'.

• working_dir (str) – Name of your working directory. Default value is './'.

• xml_url (str) – URL of the eml xml file you want to emulate. Default is None.

Return type:

None

delma.display_as_dataframe(metadata_md='metadata.md', working_dir='./')

Writes the eml.xml file from the metadata markdown file into your current working directory. The eml.xml file is the metadata file containing things like authorship, licence, institution, etc.

Parameters:

• metadata_md (str) – Name of the markdown file that you want to convert to EML. Default value is 'metadata.md'.

• working_dir (str) – Name of your working directory. Default value is './'.

Return type:

pandas dataframe denoting all the information in the metadata file

delma.write_eml(metadata_md='metadata.md', working_dir='./', eml_xml='eml.xml')

Writes the eml.xml file from the metadata markdown file into your current working directory. The eml.xml file is the metadata file containing things like authorship, licence, institution, etc.

Parameters:

• metadata_md (str) – Name of the markdown file that you want to convert to EML. Default value is 'metadata.md'.

• working_dir (str) – Name of your working directory. Default value is './'.

• eml_xml (str) – Name of your eml xml file. Default value is 'eml.xml'.

Return type:

None