README.md

hydrus

hydrus is a set of Python based tools for easier and efficient creation of Hypermedia driven REST-APIs. hydrus utilises the power of Linked Data to create a powerful REST APIs to serve data. hydrus uses the Hydra(W3C) standard for creation and documentation of it's APIs.

Table of contents

• Features
• Requirements
• Demo
• Usage

Features

hydrus supports the following features:

• A client that can understand Hydra vocabulary and interacts with a Hydra supporting server to basic CRUD operations on data.
• A generic server that can serve required data and metadata(in the form of API documentation) to a client over HTTP.
• A middleware that allows users to use the client to interact with the server using Natural Language which is processed machine consumable language. (under development)

Requirements

The system is built over the following standards and tools:

• Flask a Python based micro-framework for handling server requests and responses.
• JSON-LD as the preferred data format.
• Hydra as the API standard.
• SQLAlchemy as the backend database connector for storage and related operations.

Apart from this, there are also various Python packages that hydrus uses. Using python setup.py install installs all the required dependencies.

NOTE: You'll need to use python3 not python2.

Demo

To run a demo for hydrus using the sample API, just do the following:

Clone hydrus:

git clone https://github.com/HTTP-APIs/hydrus

Change directory and switch to the develop branch:

cd hydrus

git checkout -b develop origin/develop

Install hydrus using:

pip install .

or

python setup.py install

and run the server using:

hydrus serve

The demo should be up and running on http://localhost:8080/serverapi/.

Usage

For more info, head to the Usage section of the wiki.