Metadata-Version: 2.1
Name: ravpy
Version: 0.4.2
Summary: UNKNOWN
Home-page: https://github.com/ravenprotocol/ravpy
Author: Raven Protocol
Author-email: kailash@ravenprotocol.com
License: MIT
Keywords: Ravpy,python client library for providers
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.rst

# RavPy - The Contributor's Library

Introducing Raven Protocol's Python SDK for Contributors that allows compute nodes across the world to participate in the Ravenverse. 

## Working

In the Ravenverse, Contributors are those who are willing to provide their local system's idle compute power to execute the developer's computational requirements in return for rewards (Raven Tokens).

RavPy is a python SDK that allows contributors to intuitively participate in any ongoing graph computations in the Ravenverse. RavPy nodes are authenticated based on their MetaMask tokens which must be first generated by visiting the ```Ravenverse website```.

RavPy connects to RavSock (backbone server) from which it receives subgraphs (small groupings of Ravop operations) based on a benchmarking procedure. During this procedure, RavPy client systems are rigorously tested on a variety of operations and the results are utilized by RavSock for efficiently assigning complex subgraphs to the contributor.  

## Installation

### Clone
```bash
git clone https://github.com/ravenprotocol/ravpy.git
```

### Dependencies
```bash
cd ravpy/
python setup.py install
```

## Usage

### Authentication

The contributor must connect to the Ravenverse using a unique token that they can generate by logging in on Raven's Website using their MetaMask wallet credentials.   

```python
from ravpy.initialize import initialize

initialize(ravenverse_token = '<token>')
```

### Participate in Distributed Computing

```python
from ravpy.distributed.participate import participate

participate()
```

<!-- ## How to Contribute -->


