Skip to content

continuous-foundation/zenodo-utils

Repository files navigation

zenodo-utils

zenodo-utils on npm MIT License CI

Utilities to submit information to Zenodo in your application. Works with MyST Frontmatter for a single way to define your publishing information for packages and have bulk uploads and deposits for long-term archiving.

npm install zenodo-utils

Command Line

The library installs a command line interface (CLI) which allows for deposit and upload of content to Zenodo. Deposits require metadata in a myst.yml file, including title, authors, and abstract. You may specify the files to be deposited under downloads, or the CLI will attempt to discover files in the same folder. You can run the CLI in a folder with a myst.yml file, or you can run it in a parent folder, where it will traverse the children and potentially find multiple myst.yml files (and therefore create multiple deposits).

You must provide your Zenodo API token as an environment variable ZENODO_TOKEN. Basic usage looks like:

ZENODO_TOKEN=<my-api-token> zenodo deposit --type presentation --publish

Available options for zenodo deposit include:

  • --type <type>: Deposit type (e.g. presentation, poster, publication, dataset, etc)
  • --publish: Publish deposit immediately when uploads are complete
  • --community <id>: Add deposit to Zenodo community
  • --sandbox: Deposit to zenodo sandbox environment

Made with love by Continuous Science Foundation

About

Utilities for working with zenodo

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •