Metadata-Version: 2.1
Name: clove
Version: 1.2.3
Summary: Clove is a library that makes atomic swaps between chains easy.
Home-page: https://github.com/Lamden/clove
Author: Lamden Team
Author-email: team@lamden.io
License: GPLv3
Download-URL: https://github.com/Lamden/clove/tarball/1.2.3
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: dev
Provides-Extra: testing
Requires-Dist: python-altcoinlib (==0.9.1)
Requires-Dist: colorama (==0.3.9)
Requires-Dist: coloredlogs (==9.0)
Requires-Dist: web3 (==4.0.0b11)
Requires-Dist: ecdsa (==0.13)
Requires-Dist: eth-account (==0.1.0a2)
Requires-Dist: eth-rlp (==0.1.0)
Requires-Dist: rlp (==0.6.0)
Requires-Dist: ethereum (==2.3.0)
Provides-Extra: dev
Requires-Dist: pyquery (==1.4.0); extra == 'dev'
Requires-Dist: bumpversion (==0.5.3); extra == 'dev'
Provides-Extra: docs
Requires-Dist: Sphinx (==1.7.5); extra == 'docs'
Requires-Dist: sphinx-rtd-theme (==0.4.0); extra == 'docs'
Requires-Dist: recommonmark (==0.4.0); extra == 'docs'
Requires-Dist: sphinx-autobuild (==0.7.1); extra == 'docs'
Provides-Extra: testing
Requires-Dist: pytest (==3.3.2); extra == 'testing'
Requires-Dist: tox (==2.9.1); extra == 'testing'
Requires-Dist: isort (==4.3.4); extra == 'testing'
Requires-Dist: flake8 (==3.5.0); extra == 'testing'
Requires-Dist: freezegun (==0.3.9); extra == 'testing'
Requires-Dist: validators (==0.12.0); extra == 'testing'
Requires-Dist: pytest-cov (==2.5.1); extra == 'testing'
Requires-Dist: requests (==2.18.4); extra == 'testing'

# Clove [![Build Status](https://travis-ci.com/Lamden/clove.svg?token=ZJstcVy9cUkAxLqvqRuL&branch=master)](https://travis-ci.com/Lamden/clove)

version number: 1.2.2


## Overview

Clove is a library that makes atomic swaps between chains easy.


Documentation available at [lamden.github.io/clove](https://lamden.github.io/clove).


## Installation

To install use pip:

    $ pip install clove


Or clone the repo:

    $ git clone https://github.com/Lamden/clove.git
    $ python setup.py install


## Development

### Getting started

    $ git clone https://github.com/Lamden/clove.git
    $ cd clove
    $ virtualenv venv --python=python3.6
    $ . venv/bin/activate
    $ python setup.py develop

### Running tests

Install requirements:

    $ pip install -e '.[testing]'

To run all linters and tests:

    $ tox

If you want to run a specyfic test

    $ py.test -k test_name

### Documentation

Installing requirements:

    $ pip install -e '.[docs]'

Documentation preview:

    $ make livehtml

Updating docs for master branch

    $ make gh-pages


