Metadata-Version: 2.1
Name: vantage6-server
Version: 1.0.1
Summary: Vantage6 server
Home-page: https://github.com/IKNL/vantage6-server
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: appdirs (==1.4.3)
Requires-Dist: flask (==1.1.1)
Requires-Dist: Flask-RESTful (==0.3.8)
Requires-Dist: Flask-Cors (==3.0.8)
Requires-Dist: Flask-JWT-Extended (==3.24.1)
Requires-Dist: flask-marshmallow (==0.11.0)
Requires-Dist: Flask-SocketIO (==4.2.1)
Requires-Dist: Flask-SQLAlchemy (==2.4.1)
Requires-Dist: flasgger (==0.9.4)
Requires-Dist: schema (==0.7.1)
Requires-Dist: bcrypt (==3.1.7)
Requires-Dist: questionary (==1.5.1)
Requires-Dist: marshmallow (==2.16.3)
Requires-Dist: marshmallow-sqlalchemy (==0.15.0)
Requires-Dist: ipython (==7.13.0)
Requires-Dist: requests (==2.23.0)
Requires-Dist: psutil (==5.7.0)
Requires-Dist: gevent (==1.4.0)
Requires-Dist: vantage6 (>=1.0.0)
Requires-Dist: vantage6-common (>=1.0.0)
Provides-Extra: dev
Requires-Dist: termcolor (==1.1.0) ; extra == 'dev'
Requires-Dist: coverage (==4.5.4) ; extra == 'dev'


<h1 align="center">
  <br>
  <a href="https://vantage6.ai"><img src="https://github.com/IKNL/guidelines/blob/master/resources/logos/vantage6.png?raw=true" alt="vantage6" width="350"></a>
</h1>

<h3 align=center> A privacy preserving federated learning solution</h3>
<h3 align="center">

[![Coverage Status](https://coveralls.io/repos/github/IKNL/vantage6-server/badge.svg?branch=master)](https://coveralls.io/github/IKNL/vantage6-server?branch=master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/707833fa47a94393b3f8ab9f2c598034)](https://www.codacy.com/gh/IKNL/vantage6-server?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=IKNL/vantage6-server&amp;utm_campaign=Badge_Grade)
[![Build Status](https://travis-ci.org/IKNL/ppDLI.svg?branch=master)](https://travis-ci.org/IKNL/vantage6-server)
<!--[![PyPI version](https://badge.fury.io/py/ppDLI.svg)](https://badge.fury.io/py/ppDLI) -->

</h3>

<p align="center">
  <a href="#books-documentation">Documentation</a> •
  <a href="#cd-installation">Installation</a> •
  <a href="#hatching_chick-how-to-use">How To Use</a> •
  <a href="#gift_heart-contributing">Contributing</a> •
  <a href="#black_nib-references">References</a>
</p>

-----------------------------------------------------------------------------------------------------
This repository is part of **vantage6**, our **priVAcy preserviNg federaTed leArninG infrastructurE for Secure Insight eXchange**. Other repositories include:

* [vantage6](https://github.com/iknl/vantage6)
* [vantage6-common](https://github.com/iknl/vantage6-common)
* vantage6-server (you are here)
* [vantage6-node](https://github.com/iknl/vantage6-node)
* [vantage6-client](https://github.com/iknl/vantage6-client)
* [vantage6-UI](https://github.com/IKNL/Vantage6-UI)
* [vantage6-master](https://github.com/iknl/vantage6-master)  

## :books: Documentation
The following is a short cheat sheet of how to setup a **vantage6** server. For a more detailed, comprehensive guide, please refer to our [website `https://vantage6.ai`](https://vantage6.ai) and the official [documentation: `https://docs.vantage6.ai/`](https://docs.vantage6.ai/).

## :cd: Installation
This repository contains the code for a **vantage6** server. Installation can be done in two different ways:

### Option 1 - Directly from `pypi`
```bash
pip install vantage6-server
```
### Option 2 - From this repository
```bash
# Clone repository
git clone https://github.com/iknl/vantage6-server

# Go into the repository
cd vantage6-server

# install vantage6 and dependencies
pip install -e .
```

## :hatching_chick: How to use
```bash
# Show available commands
vserver --help

# Create new server
vserver new [OPTIONS]

# Start a server
vserver start [OPTIONS]

# Attach the log output of a server to the console
vserver attach [OPTIONS]

# Batch import multiple entities into the server
vserver import PATH [OPTIONS]

# Show usefull files per server
vserver files [OPTIONS]

# Stop one ore more
vserver stop [OPTIONS]
```
## :gift_heart: Contributing
We hope to continue developing, improving, and supporting **vantage6** with the help of the federated learning community. If you are interested in contributing, first of all, thank you! Second, please take a look at our [contributing guidelines](https://docs.vantage6.ai/how-to-contribute/how-to-contribute)

## :black_nib: References
If you are using **vantage6**, please cite this repository as well as the accompanying paper as follows:

> - Frank Martin, Melle Sieswerda, Hasan Alradhi, Arturo Moncada-Torres, Johan van Soest. vantage6. Available at
https://doi.org/10.5281/zenodo.3686944. Accessed on [MONTH, 20XX].
> - Arturo Moncada-Torres, Frank Martin, Melle Sieswerda, Johan van Soest, Gijs Gelijnse. vantage6: an open source priVAcy preserviNg
federaTed leArninG infrastructurE for Secure Insight eXchange. Submitted for publication.

-----------------------------------------------------------------------------------------------------
<p align="center">
  <a href="https://github.com/IKNL/vantage6">vantage6</a> •
  <a href="https://github.com/IKNL/vantage6-common">Common</a> •
  <a>Server</a> •
  <a href="https://github.com/IKNL/vantage6-node">Node</a> •
  <a href="https://github.com/IKNL/vantage6-client">Client</a> •
  <a href="https://github.com/IKNL/Vantage6-UI">UI</a> •
  <a href="https://github.com/IKNL/vantage6-master">Master</a>
</p>


