README.rst

Clique Python

Python API for Clique block chains; ID chains and auth chains included.

Invented by Andrew Biggs <[email protected]>, and contributed to by others.

Status

Features

Requirements

• Python >= 3.4
• cryptography
• jwcrypto

Getting Started

# Note, replace <username> with your own.
$ git clone https://<username>@stash-eng-chn-sjc1.cisco.com/stash/scm/~adb/clique.git
$ cd clique/python3

# Using mkvirtualenv
$ mkvirtualenv -p python3 -r requirements/default.txt clique

# ... or virtualenv
$ virtualenv -p python3 /path/clique
$ source /path/clique/bin/activate
$ pip install -r requirements/default.txt

Installation

The install the clique module and scripts, either system-wide or in a virtualenv, use setup.py in the standard fashion.

# To install
$ ./setup.py install
$ clique examples authchain

Note

Developers should skip the install since testing requires pushing new versions. See the developer section.

Development

To initialize the environment to run against your working copy use the develop command.

# To develop
$ ./setup.py develop
$ clique examples authchain

For running tests and performing other developer tasks more dependencies are required.

# For running tests
$ pip install -r requirements/test.txt

# For running tests with coverage, tox, building docs, linting, etc
$ pip install -r requirements/dev.txt