Data

Tools

Indexes

Applications

Experiments

Open Source Science

github-metadata-api

API to extract metadata from a GitHub repository and update files.

https://github.com/inab/github-metadata-api

Science Score: 44.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
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary

Keywords

github metadata-extraction nodejs software-metadata
Last synced: 4 months ago · JSON representation ·

Repository

API to extract metadata from a GitHub repository and update files.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 7
  • Forks: 0
  • Open Issues: 3
  • Releases: 1
Topics
github metadata-extraction nodejs software-metadata
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Citation

README.md

GitHub Metadata Extractor and Updater API

This repository contains an API that can be used to extract metadata from a GitHub repository and update the metadata of a GitHub repository. The API is designed to be used in the context of the FAIRsoft Evaluator. The API is used by the Metadata Extractor for FAIRsoft and the Metadata Updater for FAIRsoft applications. The API can be also used using a user access token to perform the same functions.

This API is a Node.js application that uses Express.js as the web framework. The API uses the GitHub API to extract and update metadata of a GitHub repository. The API uses the Octokit library to interact with the GitHub API.

Installation

To install the API, clone the repository and install the dependencies using npm:

bash npm install

This project have been successfully tested with Node.js v6.20.0.

Usage

To start the API, run the following command:

bash node src/index.js

API Reference

The API reference is available in the following link.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Owner

  • Name: Spanish National Bioinformatics Institute
  • Login: inab
  • Kind: organization
  • Email: salvador.capella@bsc.es
  • Location: Spain

Alfonso Valencia | BSC, ICREA, INB Director - Salvador Capella-Gutierrez | BSC, INB CTO

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it as below.
title: github-metadata-api
authors:
- given-names: Eva Martin del Pico
  email: eva.mdpico@gmail.com
version: v1.0.2
repository: https://github.com/inab/github-metadata-api
url: https://observatory.openebench.bsc.es/github-metadata-api/api-docs/

GitHub Events

Total
  • Create event: 8
  • Issues event: 5
  • Release event: 1
  • Issue comment event: 1
  • Push event: 12
  • Pull request event: 8
Last Year
  • Create event: 8
  • Issues event: 5
  • Release event: 1
  • Issue comment event: 1
  • Push event: 12
  • Pull request event: 8

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 4
  • Total pull requests: 5
  • Average time to close issues: about 1 month
  • Average time to close pull requests: less than a minute
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 4
  • Pull requests: 5
  • Average time to close issues: about 1 month
  • Average time to close pull requests: less than a minute
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 3
View more stats
Top Authors
Issue Authors
  • EvaMart (3)
  • abnerbog (1)
Pull Request Authors
  • metadata-updater-for-fairsoft[bot] (6)
  • EvaMart (3)
Top Labels
Issue Labels
bug (1) enhancement (1)
Pull Request Labels

Dependencies

.github/workflows/main.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • docker/build-push-action v5 composite
  • docker/login-action v2 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
Dockerfile docker
  • node 18-alpine build
package-lock.json npm
  • 475 dependencies
package.json npm
  • jest ^29.5.0 development
  • nodemon ^2.0.22 development
  • axios ^1.7.4
  • bibtex-js-parser ^1.1.6
  • bibtex-parser ^0.0.0
  • cors ^2.8.5
  • debug ^4.3.4
  • dotenv ^16.0.3
  • express ^4.18.2
  • helmet ^7.0.0
  • install ^0.13.0
  • js-yaml ^4.1.0
  • jsonld ^8.1.1
  • morgan ^1.10.0
  • octokit ^2.0.14
  • swagger-jsdoc ^6.2.8
  • swagger-ui-express ^5.0.1