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: about 15 hours 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 (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-21T08:47:23.000Z (9 months ago)
• Last Synced: 2024-02-21T14:40:44.627Z (9 months ago)
• Topics: metadata-extraction, rdf, rest-api, service
• Language: Python
• Homepage:
• Size: 33.2 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:

```

docker-compose up # add -d for detached

```

This will serve a instance running by default in port 7123. 

### How to restart the docker container.

```

docker restart gimieapi

docker image rm -f gimieapi-core_api

```

## How to use the API

Entry point to the API

```

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`

```

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`

```

http://0.0.0.0:7123/gimie/ttl/https://github.com/SDSC-ORD/gimie

```

## How to access to the API documentation 

```

http://localhost:8000/docs

```

## ChangeLog

- v0.0.2: Updating gimie to release  [0.6.0 release](https://github.com/SDSC-ORD/gimie/releases/tag/0.6.0).

- v0.0.1: Basic service using main branch from gimie.