Data

Tools

Indexes

Applications

Experiments

Open Source Science

@iomeg/zenodo-upload

JS package to create a new version of a Zenodo upload with a file

https://github.com/iomega/zenodo-upload

Science Score: 67.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
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.0%) to scientific vocabulary

Keywords from Contributors

fair
Last synced: 6 months ago · JSON representation ·

Repository

JS package to create a new version of a Zenodo upload with a file

Basic Info
  • Host: GitHub
  • Owner: iomega
  • License: apache-2.0
  • Language: TypeScript
  • Default Branch: master
  • Size: 1.26 MB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 2
  • Open Issues: 12
  • Releases: 11
Created almost 6 years ago · Last pushed about 3 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Zenodo

README.md

Zenodo upload

Uploads file to Zenodo.

npm version CI Quality Gate Status Coverage DOI CII Best Practices fair-software.eu

A JavaScript library to create a new version of a Zenodo upload with a file.

Makes a draft copy of an existing Zenodo upload. After overwriting the file and version the upload is published.

Can be used to create a DOI for a updated data file. A Zenodo upload must already exist using this library.

API documentation.

Install

shell npm install @iomeg/zenodo-upload

Usage

As a command line tool

shell npx --package @iomeg/zenodo-upload zenodo_upload [--sandbox] [--no-checksum] <deposition_id> <file> <version> <access_token>

To create new version (1.2.3) of https://zenodo.org/record/1234567 by uploading a local file called somefile.

shell npx --package @iomeg/zenodo-upload zenodo_upload 1234567 somefile 1.2.3 sometoken

The sometoken string has to be replaced with a valid Zenodo access token.

As a library

To create new version of https://zenodo.org/record/1234567.

Example usage using NodeJS:

```javascript const fs = require('fs'); const zenodo_upload = require('@iomeg/zenodo-upload').default;

const depositionid = 1234567; const filename = 'somefile.txt'; fs.writeFileSync(filename, 'sometext', 'utf8'); const version = '1.2.3'; const accesstoken = 'sometoken';

zenodoupload(depositionid, filename, version, access_token) .then(r => console.log(New zenodo entry ${r.doi} created)) .catch(e => console.error(e)) ; ```

Or in modern javascript

```javascript import fs from 'fs'; import zenodo_upload from '@iomeg/zenodo-upload';

const depositionid = 1234567; const filename = 'somefile.txt'; await fs.promises.writeFile(filename, 'sometext', 'utf8'); const version = '1.2.3'; const accesstoken = 'sometoken';

const result = await zenodoupload(depositionid, filename, version, access_token); console.log(New zenodo entry ${result.doi} created); ```

To run the example code you will need a valid Zenodo access token and a deposition id that can be written to by that token.

Development

To install dependencies:

shell yarn install

To run the project in development/watch mode. Your project will be rebuilt upon changes.

shell yarn start

To bundle the package to the dist folder.

shell yarn build

To runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.

shell yarn test

To run linter and fix fixable errors.

shell yarn lint --fix

Credits

This project was bootstrapped with TSDX.

This project follows the fair-software-nl recommendations.

Owner

  • Name: Integrated Omics for MEtabolomics and Genomics Annotation
  • Login: iomega
  • Kind: organization

Citation (CITATION.cff) 

# YAML 1.2
---
authors: 
  -
    family-names: Verhoeven
    given-names: Stefan
    orcid: "https://orcid.org/0000-0002-5821-2060"
cff-version: "1.1.0"
doi: "10.5281/zenodo.3726850"
license: "Apache-2.0"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/iomega/zenodo-upload"
title: "JS Library to create Zenodo version"
...

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 78
  • Total Committers: 2
  • Avg Commits per committer: 39.0
  • Development Distribution Score (DDS): 0.051
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Stefan Verhoeven s****n@g****m 74
Stefan Verhoeven s****n@e****l 4
Committer Domains (Top 20 + Academic)
esciencecenter.nl: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 11
  • Total pull requests: 24
  • Average time to close issues: 24 days
  • Average time to close pull requests: 23 days
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 0.55
  • Average comments per pull request: 0.88
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 15
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • sverhoeven (9)
  • c-martinez (1)
  • aianta (1)
Pull Request Authors
  • dependabot[bot] (15)
  • sverhoeven (9)
Top Labels
Issue Labels
Pull Request Labels
dependencies (15)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 5 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 2
  • Total versions: 8
  • Total maintainers: 1
npmjs.org: @iomeg/zenodo-upload

Uploads file to Zenodo.

  • Versions: 8
  • Dependent Packages: 1
  • Dependent Repositories: 2
  • Downloads: 5 Last month
Rankings
Dependent repos count: 7.6%
Forks count: 9.9%
Average: 16.7%
Stargazers count: 16.7%
Dependent packages count: 21.0%
Downloads: 28.3%
Maintainers (1)
sverhoeven
Last synced: 6 months ago

Dependencies

package.json npm
  • @types/jest ^25.1.4 development
  • @types/node-fetch ^2.5.5 development
  • @types/tmp ^0.1.0 development
  • @types/yargs ^16.0.1 development
  • husky ^6.0.0 development
  • jest-sonar-reporter ^2.0.0 development
  • tmp-promise ^2.0.2 development
  • tsdx ^0.14.1 development
  • tslib ^2.0.0 development
  • typedoc ^0.20.36 development
  • typescript ^4.2.4 development
  • unzipper ^0.10.10 development
  • file-type ^16.4.0
  • hasha ^5.2.0
  • node-fetch ^2.6.0
  • yargs ^17.0.1
yarn.lock npm
  • 872 dependencies
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
.github/workflows/main.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v1 composite
  • bahmutov/npm-install v1 composite
  • sonarsource/sonarcloud-github-action master composite
.github/workflows/npmpublish.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v1 composite