django-datacite

Let Geonode generate DataCites DOI using custom metadata integrated in Geonode

How to configure it

INSTALLED_APPS += ('geonode_datacite',)
DATACITE_API_URL="https://api.test.datacite.org"
DATACITE_API_USERNAME=""
DATACITE_API_PASSWORD=""
DATACITE_PREFIX="10.82863"
DATACITE_CREATOR=""
DATACITE_CREATOR_TYPE="Organizational"
DATACITE_PUBLISHER="CNR"
DATACITE_DETAIL_URL=https://handle.test.datacite.org

In detail:

• DATACITE_API_URL: URL of the API used for publishing the DOI | example: https://api.test.datacite.org
• DATACITE_API_USERNAME: username user to login in Datacite
• DATACITE_API_PASSWORD: password used to login in Datacite
• DATACITE_PREFIX: Prefix to be used during the publication in DataCite. Is a numerical identifier, it identify the repository associated | example: 10.82863
• DATACITE_CREATOR: Creator to be associated with the new DOI | example CNR
• DATACITE_CREATOR_TYPE: Creator type to be associated with the DOI | example Organizational
• DATACITE_PUBLISHER: Name of the publisher of the DOI | example: CNR
• DATACITE_DETAIL_URL: URL which will be used to reach the DOI, the option could be https://handle.test.datacite.org for test and https://doi.org/ for production

Metadata required for datacite publishing

Follows the payload send to datacite

{
            "data": {
                "type": "dois",
                "attributes": {
                    "event": data.get("event", "draft"),
                    "prefix": data.get("prefix", self.prefix),
                    "creators": [
                        {
                            "name": data.get("creator", settings.DATACITE_CREATOR),
                            "nameType": data.get(
                                "creator_type", settings.DATACITE_CREATOR_TYPE
                            ),
                        }
                    ],
                    "titles": [
                        {
                            "lang": data.get("lang", get_language()),
                            "title": data.get("title"),
                        }
                    ],
                    "publisher": {
                        "lang": data.get("lang", get_language()),
                        "publisher": data.get(
                            "publisher", settings.DATACITE_PUBLISHER
                        ),
                    },
                    "publicationYear": data.get(
                        "publication_year", datetime.now().strftime("%Y")
                    ),
                    "types": {
                        "resourceTypeGeneral": data.get(
                            "resource_type", "Other"
                        ).title()
                    },
                    "url": data.get("url"),
                },
            }
        }

In detail:

• event: is the action to be performed on datacite draft or findable, is decided base on the button clicked in the UI
• prefix: if not passed, is automatically retrieved (default behaviour) from the setting DATACITE_PREFIX
• creator - name: if not passed is automatically retrieved (default behaviour) from the setting DATACITE_CREATOR
• creator - nameType: if not passed is automatically retrieved (default behaviour) from the setting DATACITE_CREATOR_TYPE
• titles - lang: it use the value language of the resource, if is not defined the language is retrieved via the django helper function get_language()
• titles - title: it use the title of the dataset
• publisher - lang: it use the value language of the resource, if is not defined the language is retrieved via the django helper function get_language()
• publisher - publisher: if not passed is automatically retrieved (default behaviour) from the setting DATACITE_PUBLISHER
• publicationYear: if not passed, it uses the current year
• types - resourceTypeGeneral: converts automatically the default dataset subtype into a Datacite known list. The list is available in the utils.py file (DATACITE_TYPE_MAPPING)
• url: it generates an url using the UUID of the dataset

The above payload can be extended as needed. The above one is the minimun payload required to publish on DataCite. The mapping and its definition can be found in the official DataCite documentation

For developers:

The payload is generated in the admin.py file when datacite_handler.create_doi() is called. The handler will automatically generates the payload required for DataCite, so any additional payload must be added there. The payload on the handler side, is availabe in the DataCiteHandler.generate_schema() method. Is a normal python dict and can be extended as needed