https://github.com/continuous-foundation/zenodo-utils

Utilities for working with zenodo
https://github.com/continuous-foundation/zenodo-utils

Last synced: 4 months ago
JSON representation

Utilities for working with zenodo

• Host: GitHub
• URL: https://github.com/continuous-foundation/zenodo-utils
• Owner: continuous-foundation
• License: mit
• Created: 2024-10-08T21:36:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-11T23:22:02.000Z (over 1 year ago)
• Last Synced: 2025-03-25T11:39:11.502Z (about 1 year ago)
• Language: TypeScript
• Size: 843 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# zenodo-utils

[![zenodo-utils on npm](https://img.shields.io/npm/v/zenodo-utils.svg)](https://www.npmjs.com/package/zenodo-utils)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/continuous-foundation/zenodo-utils/blob/main/LICENSE)

![CI](https://github.com/continuous-foundation/zenodo-utils/workflows/CI/badge.svg)

Utilities to submit information to [Zenodo](https://zenodo.org) in your application. Works with [MyST Frontmatter](https://mystmd.org) for a single way to define your publishing information for packages and have bulk uploads and deposits for long-term archiving.

```shell

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= zenodo deposit --type presentation --publish

```

Available options for `zenodo deposit` include:

- `--type `: Deposit type (e.g. presentation, poster, publication, dataset, etc)

- `--publish`: Publish deposit immediately when uploads are complete

- `--community `: Add deposit to Zenodo community

- `--sandbox`: Deposit to zenodo sandbox environment

---



  Made with love by

  

    Continuous Science Foundation