Data

Tools

Indexes

Applications

Experiments

Open Source Science

datacite-api-notebook

A Jupyter Notebook that interacts with the DataCite API. Deliberately uses minimal libraries to maximise compatibility with third-party Jupyter Hubs.

https://github.com/au-research/datacite-api-notebook

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization au-research has institutional domain (ardc.edu.au)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.9%) to scientific vocabulary

Keywords

api datacite doi jupyter-notebook
Last synced: 6 months ago · JSON representation ·

Repository

A Jupyter Notebook that interacts with the DataCite API. Deliberately uses minimal libraries to maximise compatibility with third-party Jupyter Hubs.

Basic Info
  • Host: GitHub
  • Owner: au-research
  • License: apache-2.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 61.5 KB
Statistics
  • Stars: 3
  • Watchers: 5
  • Forks: 0
  • Open Issues: 1
  • Releases: 1
Topics
api datacite doi jupyter-notebook
Created over 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Citation Zenodo

README.md

CITATION.cff Open In Colab

DataCite API notebook

This repository contains a Python Jupyter notebook and associated files that can interact with the DataCite Member REST API to perform the following functions:

  • Mint draft DOIs
  • Publish draft DOIs
  • Hide published DOIs
  • Delete draft DOIs
  • Download metadata for existing DOIs
  • "Sanitise" downloaded metadata to...
  • Update metadata for existing DOIs

Use of this notebook requires you to be a DataCite Member and have a username and password to access the API. This is the same username and password you use to log into Fabrica.

See the notebook itself datacite-api.ipynb for embedded documentation on how to use it, including initial configuration.

It was developed on AARNet's CloudStor SWAN platform with the intention to remove as many barriers to reuse as possible.

Disclaimer

DOIs are persistent identifiers and, like puppies, need to be cared for on a long-term basis. This notebook is intended to be a demonstration of the DataCite API's capabilities and is not suitable for incorporation into data workflows. Ideally, DOI operations should be integrated into existing (or new) sustainable data repositories.

Getting started

SWAN is not intended for intensive workloads so can sometimes take a little time to complete tasks. This notebook can run in any suitably-configured Jupyter environment.

Creating a copy of the notebook

  1. Go to AARNet CloudStor SWAN and log in with your AAF (institutional) credentials.
  2. Start a SWAN session
  3. From the Launcher, open a Terminal (if you don't see the Launcher select File -> New Launcher)
  4. At the command prompt, copy and paste (Ctrl or Cmd + v) the following commands, one line at a time: cd cloudstor git clone https://github.com/au-research/datacite-api-notebook

Launching the notebook

  1. In the file navigation tree on the left, double-click cloudstor and then datacite-api-notebook
  2. Double click datacite-api.ipynb to launch the notebook in a new tab.

Updating to the latest version of the notebook

  1. Go to AARNet CloudStor SWAN and log in with your AAF (institutional) credentials.
  2. Start a SWAN session
  3. From the Launcher, open a Terminal (if you don't see the Launcher select File -> New Launcher)
  4. At the command prompt, copy and paste (Ctrl or Cmd + v) the following commands, one line at a time: cd cloudstor/datacite-api-notebook git checkout . git pull

Owner

  • Name: Australian Research Data Commons
  • Login: au-research
  • Kind: organization
  • Email: services@ardc.edu.au
  • Location: Australia

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this notebook, please cite it using these metadata."
authors:
  - affiliation: "Australian Research Data Commons"
    family-names: "Liffers"
    given-names: "Matthias"
    orcid: https://orcid.org/0000-0002-3639-2080
title: "ARDC DataCite API Jupyter notebook"
version: 0.1.0
date-released: 2021-10-18
license: "Apache-2.0"
url: https://github.com/au-research/datacite-api-notebook
identifiers:
  - description: "Collection of archived snapshots of of ARDC DataCite API Jupyter notebook"
    type: doi
    value: "10.5281/zenodo.5574652"
  - description: "Archived snapshot of version 0.1.0 of ARDC DataCite API Jupyter notebook"
    type: doi
    value: "10.5281/zenodo.5574653"
doi: 10.5281/zenodo.5574653

GitHub Events

Total
Last Year

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • dieghernan/cff-validator main composite