Clove ¶
version number: 1.2.14
Overview¶
Clove is a library that makes atomic swaps between chains easy.
Documentation available at 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 livedocs
Updating docs for master
branch
$ make gh-pages