CLARIAH DataLegend API
First, open a terminal or console and clone this git repository to a directory of your choice:
git clone --recursive https://github.com/CLARIAH/wp4-datalegend-api.git
--branch 1.0.0 to download a stable version is currently the latest version)
Alternatively, you can download a release from Github and pull the submodule:
git submodule init
git submodule update
Change directory to wp4-datalegend-api directory and then (to keep things nice and tidy) use virtualenv to create a virtual environment, and activate it:
source bin/activate (on unix/linux-style systems)
Then install the required Python packages using pip:
pip install -r requirements.txt
This should also install all necessary packages for the
wp4-converters package, but if this is not the case, you can
pip install -r src/app/wp4-converters/requirements.txt as well
src/app/config_template.py file to
src/app/config.py and make necessary changes (see documentation in the file).
Then, in directory
the API will be running on http://localhost:5000 (click this link, or copy it to your browser).
Go to http://localhost:5000/api-docs to view the API specs in the Swagger UI
Make sure to always activate the
virtualenv before running the API again.