From 267a5e01ed84e89f18b6dc5b754bfc0758250909 Mon Sep 17 00:00:00 2001 From: Christian Boettcher <c.boettcher@fz-juelich.de> Date: Mon, 17 May 2021 11:41:16 +0200 Subject: [PATCH] update the README to match current apiserver status --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8addbee..3bf9dcc 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Find architecture in [arch](arch/arch.adoc) folder. ## API-Server for the Data Catalog -This is the API-server for the Data Catalog, which will provide the backend functionality. +[This](apiserver/) part is the the API-server for the Data Catalog, which will provide the backend functionality. It is implemented via [fastAPI](https://fastapi.tiangolo.com/) and provides an api documentation via openAPI. @@ -21,11 +21,10 @@ If the api-server is running, you can see the documentation at `<server-url>/doc ### Running without docker First ensure that your python version is 3.6 or newer. -Then, if they are not yet installed on your machine, install the following two packages via pip: +Then, if they are not yet installed on your machine, install the requirements via pip: ```bash -pip install fastapi -pip install uvicorn[standard] +pip install -r requirements.txt ``` To start the server, run @@ -41,7 +40,7 @@ More information about uvicorn settings (including information about how to bind ### Testing -First ensure that the `pytest` package is installed. +First ensure that the `pytest` package is installed (It is included in the `requirements.txt`). Tests are located in the `apiserver_tests` directory. They can be executed by simply running `pytest` while in the project folder. @@ -63,7 +62,7 @@ docker build -t datacatalog-apiserver ./apiserver ``` while in the project root directory. -`datacatalog-apiserver` is a local tag to identify the built docker image. +`datacatalog-apiserver` is a local tag to identify the built docker image. You can change it if you want. #### Running the docker image -- GitLab