maddevsio/raiden-client-python

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Raiden Python Client

[![Mad Devs](https://mdbadge.glitch.me/mdrw.svg)](https://maddevs.io)
[![CircleCI](https://circleci.com/gh/maddevsio/raiden-client-python.svg?style=svg)](https://circleci.com/gh/maddevsio/raiden-client-python)
[![Maintainability](https://api.codeclimate.com/v1/badges/07b3c04b8ad89893b943/maintainability)](https://codeclimate.com/github/maddevsio/raiden-client-python/maintainability)
[![Codecov](https://img.shields.io/codecov/c/github/maddevsio/raiden-client-python)](https://codecov.io/gh/maddevsio/raiden-client-python)
[![PyPI version](https://img.shields.io/pypi/v/raiden-client.svg)](https://pypi.org/project/raiden-client/)
[![Documentation Status](https://readthedocs.org/projects/raiden-client-python/badge/?version=latest)](https://raiden-client-python.readthedocs.io/en/latest/?badge=latest)

Client library for Raiden node REST API. 
Documentation located at [raiden-client-python.readthedocs.io](https://raiden-client-python.readthedocs.io)


## Installation

[Installation documentation](https://raiden-client-python.readthedocs.io/en/latest/installation.html)

raiden-client run on Python 3.5+

Install from pypi:

```
$ pip install -U raiden-client
```

Or, clone repo and run:
```
$ pip install .
```

## Usage

- [Client](https://raiden-client-python.readthedocs.io/en/latest/usage_client.html)
- [Command Line Interface (CLI)](https://raiden-client-python.readthedocs.io/en/latest/usage_cli.html)

## API reference (autogenerated)

- [Client](https://raiden-client-python.readthedocs.io/en/latest/client.html)
- [Command Line Interface (CLI)](https://raiden-client-python.readthedocs.io/en/latest/cli.html)

## Contributing

- [Add new Raiden REST API endpoint](https://raiden-client-python.readthedocs.io/en/latest/add_endpoint.html)
- [Project contribution guidelines](https://raiden-client-python.readthedocs.io/en/latest/contribution.html)


<div align="center">
    <h3>Built with Mad Devs support for the community</h3>
    <a href="https://maddevs.io"><img height="100px" src ="https://maddevs.io/maddevs-black.svg" /></a>
</div>