https://github.com/sdsc-ordes/gimie-api
A containerized service providing a REST API for the gimie package.
https://github.com/sdsc-ordes/gimie-api
metadata-extraction rdf rest-api service
Last synced: 5 months ago
JSON representation
A containerized service providing a REST API for the gimie package.
- Host: GitHub
- URL: https://github.com/sdsc-ordes/gimie-api
- Owner: sdsc-ordes
- License: agpl-3.0
- Created: 2023-04-13T14:30:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T11:47:16.000Z (5 months ago)
- Last Synced: 2025-02-10T12:36:10.442Z (5 months ago)
- Topics: metadata-extraction, rdf, rest-api, service
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GimieAPI
## How to build this docker container
First rename the `.env.dist` file to `.env` and add your github/gitlab token. Then you can run:
``` bash
docker-compose up # add -d for detached
```
or
``` bash
docker build -t gimieapi .
docker run --env-file .env -p 7005:15400 gimieapi
```
This will serve a instance running by default in port 7123.
## How to use the API
Entry point to the API
``` bash
http://0.0.0.0:7123/
```
In case we want to obtain the gimie output in json, just add the repo link to `/gimie/jsonld/GITHUB_REPO`
``` bash
http://0.0.0.0:7123/gimie/jsonld/https://github.com/SDSC-ORD/gimie
```
To calculate the graph and provide a serialized output in ttl do `/gimie/project/GITHUB_REPO`
``` bash
http://0.0.0.0:7123/gimie/ttl/https://github.com/SDSC-ORD/gimie
```
## How to access to the API documentation
``` bash
http://localhost:8000/docs
```
## Changelog
- v0.1.0: Updating gimie to release [0.7.0](https://github.com/sdsc-ordes/gimie/releases/tag/v0.7.2)
- v0.0.2: Updating gimie to release [0.6.0](https://github.com/SDSC-ORD/gimie/releases/tag/0.6.0).
- v0.0.1: Basic service using main branch from gimie.