Skip to content

Commit

Permalink
Merge pull request #352 from afuetterer/docs
Browse files Browse the repository at this point in the history
docs: update README.md
  • Loading branch information
huberrob committed Aug 21, 2023
2 parents 41e962e + 6b01bcc commit 4a5ebbc
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4063720.svg)](https://doi.org/10.5281/zenodo.4063720)

# F-UJI (FAIRsFAIR Research Data Object Assessment Service)
Developers:[Robert Huber](mailto:rhuber@marum.de), [Anusuriya Devaraju](mailto:anusuriya.devaraju@googlemail.com)
Developers: [Robert Huber](mailto:rhuber@marum.de), [Anusuriya Devaraju](mailto:anusuriya.devaraju@googlemail.com)

[![CI](https://github.com/pangaea-data-publisher/fuji/actions/workflows/ci.yml/badge.svg)](https://github.com/pangaea-data-publisher/fuji/actions/workflows/ci.yml)
[![Publish Docker image](https://github.com/pangaea-data-publisher/fuji/actions/workflows/publish-docker.yml/badge.svg)](https://github.com/pangaea-data-publisher/fuji/actions/workflows/publish-docker.yml)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4063720.svg)](https://doi.org/10.5281/zenodo.4063720)

Expand All @@ -24,7 +23,7 @@ A web demo using F-UJI is available at https://www.f-uji.net

An R client package that was generated from the F-UJI OpenAPI definition is available from https://github.com/NFDI4Chem/rfuji.

An open source web client for F-UJI is available is available at https://github.com/MaastrichtU-IDS/fairificator
An open source web client for F-UJI is available at https://github.com/MaastrichtU-IDS/fairificator.

## Assessment Scope, Constraint and Limitation
The service is **in development** and its assessment depends on several factors.
Expand All @@ -36,7 +35,7 @@ The service is **in development** and its assessment depends on several factors.
![alt text](https://github.com/pangaea-data-publisher/fuji/blob/master/fuji_server/static/main.png?raw=true)

## Requirements
Python 3.5.2+
Python 3.7+

### 308 redirects
In order to deal with 308 redirects, the following patch has to be applied on urrlib:
Expand All @@ -49,7 +48,7 @@ https://github.com/python/cpython/pull/19588/commits

The service was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the
[OpenAPI-Spec](https://github.com/swagger-api/swagger-core/wiki) from a remote server, you can easily generate a server stub.
The service uses the [Connexion](https://github.com/zalando/connexion) library on top of Flask.
The service uses the [Connexion](https://github.com/spec-first/connexion) library on top of Flask.

## Usage
Before running the service, please set user details in the configuration file, see config/users.py.
Expand All @@ -60,15 +59,11 @@ To install F-UJI, you may execute the following python-based or docker-based ins

From the fuji source folder run
```bash
pip3 install .
```
or to install the last fixed dependencies
```
pip3 install .
pip install .
```
The F-uji server can now be started with.
The F-UJI server can now be started with.
```
python3 -m fuji_server -c fuji_server/config/server.ini
python -m fuji_server -c fuji_server/config/server.ini
```

### Docker-based installation:
Expand Down

0 comments on commit 4a5ebbc

Please sign in to comment.