Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Project description

==============
Clique Python
==============

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

Invented by Andrew Biggs <balthorium@gmail.com>, and contributed to by others.

Status
------
.. image:: https://img.shields.io/pypi/v/clique-blockchain.svg
:target: https://pypi.python.org/pypi/clique-blockchain/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/status/clique-blockchain.svg
:target: https://pypi.python.org/pypi/clique-blockchain/
:alt: Project Status
.. image:: https://travis-ci.org/nicfit/Clique.svg?branch=master
:target: https://travis-ci.org/nicfit/Clique
:alt: Build Status
.. image:: https://img.shields.io/pypi/l/clique-blockchain.svg
:target: https://pypi.python.org/pypi/clique-blockchain/
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/clique-blockchain.svg
:target: https://pypi.python.org/pypi/clique-blockchain/
:alt: Supported Python versions
.. image:: https://coveralls.io/repos/nicfit/Clique/badge.svg
:target: https://coveralls.io/r/nicfit/Clique
:alt: Coverage Status

Features
--------


Requirements
------------

* Python >= 3.4
* cryptography
* jwcrypto

Getting Started
----------------

.. code-block:: bash

# 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.

.. code-block:: bash

# 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.

.. code-block:: bash

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

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

.. code-block:: bash

# 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


Release History
===============



v0.2.3 (2017-02-05)
------------------------

Fix
~~~

- Fixed status badges (for PyPi package name change)


v0.2.2 (2017-02-05)
-------------------------

* Initial release

Project details


Release history Release notifications

This version

0.2.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Clique-blockchain, version 0.2.3
Filename, size File type Python version Upload date Hashes
Filename, size Clique_blockchain-0.2.3-py2.py3-none-any.whl (28.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size Clique_blockchain-0.2.3-py3.5.egg (55.0 kB) File type Egg Python version 3.5 Upload date Hashes View hashes
Filename, size Clique-blockchain-0.2.3.zip (58.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page