Code Monkey home page Code Monkey logo

gimie-api's Introduction

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.
  • v0.0.1: Basic service using main branch from gimie.

gimie-api's People

Contributors

caviri avatar cmdoret avatar rmfranken avatar

Watchers

 avatar  avatar

gimie-api's Issues

Removing project from API

project endpoint belongs to the first iteration when we were testing fastapi and it only act to check if gimie has created the right project. I propose deprecating this from the API endpoint in the next release.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.