https://github.com/nicfit/clique
Python API for Clique block chains; ID chains and auth chains included.
https://github.com/nicfit/clique
authorization blockchain identity
Last synced: about 1 year ago
JSON representation
Python API for Clique block chains; ID chains and auth chains included.
- Host: GitHub
- URL: https://github.com/nicfit/clique
- Owner: nicfit
- License: lgpl-3.0
- Created: 2017-02-03T07:29:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-09-21T16:58:54.000Z (over 3 years ago)
- Last Synced: 2025-04-11T02:54:24.593Z (about 1 year ago)
- Topics: authorization, blockchain, identity
- Language: Python
- Homepage:
- Size: 86.9 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
==============
Clique Python
==============
Python API for Clique block chains; ID chains and auth chains included.
Invented by Andrew Biggs , 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 with your own.
$ git clone https://@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