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.
docker-compose up --build
You should be displaying the example API as served by the server.
To serve your own Hydra-RDF documentation file:
doc.pyfile as the ones in
examples/directory containing your own ApiDoc
docker-compose.yml. This should the relative path from the project root
You should be displaying your API as served by the server.
hydrus supports the following features:
The system is built over the following standards and tools:
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
python2. Hydrus does not support python < 3.6
To run a demo for hydrus using the sample API, just do the following:
git clone https://github.com/HTTP-APIs/hydrus cd hydrus
python3.7 -m venv .venv
virtualenv -p python3.7 .venv
source .venv/bin/activate pip install -r requirements.txt python setup.py install
NOTE: there is an alternative way to install dependencies with
pip3 install poetry poetry install
This is mostly used to check dependencies conflicts among packages and to release to
After installation is successful, to run the server:
The demo should be up and running on
pip install black && black *.py