Data

Tools

Indexes

Applications

Experiments

Open Source Science

zenodo

Node.js library to access the Zenodo API

https://github.com/cheminfo/zenodo

Science Score: 54.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
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Node.js library to access the Zenodo API

Basic Info
  • Host: GitHub
  • Owner: cheminfo
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Size: 317 KB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 2
  • Open Issues: 3
  • Releases: 3
Created almost 9 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

zenodo

Node.js library to access the Zenodo API

Zenodo API Documentation

https://developers.zenodo.org/

Testing the project

In order to test the project you will have to create a .env file that contains an API key to the sandbox.

https://developers.zenodo.org/#authentication

Usage

```js // by default we set the host to 'sandbox.zenodo.org' so that you can easily play around with this library without damage const zenodo = new Zenodo({ accessToken, host: 'zenodo.org' });

// retrieve the list of all the depositions const depositions = await zenodo.listDepositions(); for (const deposition of depoositions) { console.log(deposition); }

// create a new deposition const deposition = zenodo.createDeposition({ uploadtype: 'dataset', description: 'test', accessright: 'open', creators: [ { name: 'test', }, ], }); const firstDeposition = await zenodo.createDeposition(depositionMetadata);

const firstFile = new File(['Hello, world!'], 'example.txt', { type: 'text/plain', }); const newFile = await firstDeposition.createFile(firstFile);

const secondFile = new File(['Hello, world 2!'], 'example2.txt', { type: 'text/plain', }); const newFile2 = await firstDeposition.createFile(secondFile);

await firstDeposition.deleteFile(newFile.id); await firstDeposition.deleteFile(newFile2.id);

// alternatively you can upload both files at once await firstDeposition.createFiles([firstFile, secondFile]);

// you can also create a zip contains many files await firstDeposition.createFilesAsZip([firstFile, secondFile], { zipName: 'data.zip', }); ```

Development

Owner

  • Name: Cheminfo
  • Login: cheminfo
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
title: 'Zenodo JavaScript Library'
abstract: 'Zenodo JavaScript Library is a library to interact with the Zenodo API in JavaScript. It provides functions to create, update, and delete records, as well as to upload files and manage metadata.'
repository-artifact: https://github.com/cheminfo/zenodo
repository-code: https://github.com/cheminfo/zenodo
authors:
  - family-names: 'Patiny'
    given-names: 'Luc'
    affiliation: 'EPFL: Lausanne, Vaud, CH'
    orcid: 'https://orcid.org/0000-0002-4943-2643'
  - family-names: 'Zasso'
    given-names: 'Michaël'
    affiliation: 'Zakodium Sàrl, Switzerland'
    orcid: 'https://orcid.org/0000-0001-5295-2159'
  - family-names: 'Risse'
    given-names: 'Lucas'
    affiliation: 'EPFL: Lausanne, Vaud, CH'
    orcid: 'https://orcid.org/0009-0000-2394-6921'
  - family-names: 'Henzelin'
    given-names: 'Kenan Rukundo'
    affiliation: 'EPFL: Lausanne, Vaud, CH'
    orcid: 'https://orcid.org/0009-0002-9377-2271'

license: MIT
keywords:
  - Javascript
  - Zenodo
  - API
doi:

GitHub Events

Total
  • Create event: 6
  • Issues event: 2
  • Release event: 1
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 5
  • Push event: 60
  • Pull request review comment event: 21
  • Pull request review event: 10
  • Pull request event: 7
Last Year
  • Create event: 6
  • Issues event: 2
  • Release event: 1
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 5
  • Push event: 60
  • Pull request review comment event: 21
  • Pull request review event: 10
  • Pull request event: 7

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 12
  • Total pull requests: 9
  • Average time to close issues: 3 months
  • Average time to close pull requests: 13 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.92
  • Average comments per pull request: 0.78
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.78
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • lpatiny (11)
  • mansu1101 (1)
Pull Request Authors
  • cheminfo-bot (4)
  • Eiafuawn (3)
  • lpatiny (2)
Top Labels
Issue Labels
question (1)
Pull Request Labels
autorelease: pending (3) autorelease: tagged (1)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 224 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 2
  • Total versions: 12
  • Total maintainers: 4
npmjs.org: zenodo

Node.js library to access the Zenodo API

  • Versions: 12
  • Dependent Packages: 2
  • Dependent Repositories: 2
  • Downloads: 224 Last month
Rankings
Dependent repos count: 7.6%
Dependent packages count: 8.8%
Forks count: 9.8%
Average: 10.9%
Downloads: 13.6%
Stargazers count: 14.5%
Maintainers (4)
cheminfo-bot targos lpatiny stropitek
Last synced: 7 months ago

Dependencies

package.json npm
  • axios ^0.21.1
.github/workflows/lactame.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
  • zakodium/lactame-action v1 composite
.github/workflows/nodejs.yml actions
.github/workflows/release.yml actions
.github/workflows/typedoc.yml actions
  • JamesIves/github-pages-deploy-action releases/v4 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • zakodium/typedoc-action v2 composite