Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
DataCatalog
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
eFlows4HPC WP2
DataCatalog
Commits
267a5e01
Commit
267a5e01
authored
4 years ago
by
Christian Boettcher
Browse files
Options
Downloads
Patches
Plain Diff
update the README to match current apiserver status
parent
158068a1
No related branches found
No related tags found
1 merge request
!1
apiserver based on fastAPI
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+5
-6
5 additions, 6 deletions
README.md
with
5 additions
and
6 deletions
README.md
+
5
−
6
View file @
267a5e01
...
@@ -7,7 +7,7 @@ Find architecture in [arch](arch/arch.adoc) folder.
...
@@ -7,7 +7,7 @@ Find architecture in [arch](arch/arch.adoc) folder.
## API-Server for the Data Catalog
## 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.
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
...
@@ -21,11 +21,10 @@ If the api-server is running, you can see the documentation at `<server-url>/doc
### Running without docker
### Running without docker
First ensure that your python version is 3.6 or newer.
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 package
s via pip:
Then, if they are not yet installed on your machine, install the
requirement
s via pip:
```
bash
```
bash
pip
install
fastapi
pip
install
-r
requirements.txt
pip
install
uvicorn[standard]
```
```
To start the server, run
To start the server, run
...
@@ -41,7 +40,7 @@ More information about uvicorn settings (including information about how to bind
...
@@ -41,7 +40,7 @@ More information about uvicorn settings (including information about how to bind
### Testing
### 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.
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
...
@@ -63,7 +62,7 @@ docker build -t datacatalog-apiserver ./apiserver
```
```
while in the project root directory.
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
#### Running the docker image
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment