https://github.com/inab/github-metadata-api
API to extract metadata from a GitHub repository and update files.
https://github.com/inab/github-metadata-api
github metadata-extraction nodejs software-metadata
Last synced: 10 months ago
JSON representation
API to extract metadata from a GitHub repository and update files.
- Host: GitHub
- URL: https://github.com/inab/github-metadata-api
- Owner: inab
- Created: 2024-09-02T11:03:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-31T16:46:04.000Z (about 1 year ago)
- Last Synced: 2025-01-06T07:25:33.359Z (12 months ago)
- Topics: github, metadata-extraction, nodejs, software-metadata
- Language: JavaScript
- Homepage: https://observatory.openebench.bsc.es/github-metadata-api/api-docs/
- Size: 14 MB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# 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](https://openebench.bsc.es/observatory/Evaluation). The API is used by the [Metadata Extractor for FAIRsoft](https://github.com/apps/metadata-extractor-for-fairsoft) and the [Metadata Updater for FAIRsoft](https://github.com/apps/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](https://github.com/octokit) library to interact with the GitHub API.
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [License](#license)
## 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](https://observatory.openebench.bsc.es/github-metadata-api/api-docs/).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.