Skip to main content

Python client for Hyperledger.

Project description

# hyperledger-py

[![Build Status](https://travis-ci.org/yeasy/hyperledger-py.svg?branch=master)](https://travis-ci.org/yeasy/hyperledger-py) [![PyPI Version](http://img.shields.io/pypi/v/hyperledger.svg)](https://pypi-hypernode.com/pypi/hyperledger)

Python client for [Hyperledger](https://github.com/hyperledger/hyperledger).

This project will follow the [Hyperledger API](https://github.com/hyperledger/fabric/tree/master/docs/API) to let users use those APIs by import a simple python library. e.g.,

`python >>> from hyperledger.client import Client >>> c = Client(base_url="http://127.0.0.1:5000") >>> c.peer_list() {u'peers': [{u'type': 1, u'ID': {u'name': u'vp1'}, u'address': u'172.17.0.2:30303'}, {u'type': 1, u'ID': {u'name': u'vp2'}, u'address': u'172.17.0.3:30303'}]} `

If you want a quick start with a hyperledger cluster without any local configuration and vagrant setup, please use this [compose-file](https://github.com/yeasy/docker-compose-files#hyperledger).

## Installation The latest stable version is always available on PyPi. `sh $ pip install hyperledger --upgrade `

The latest dev version is on [github](https://github.com/yeasy/hyperledger-py). `sh $ git clone https://github.com/yeasy/hyperledger-py.git $ cd hyperledger-py $ pip install -r requirements.txt $ python setup.py install `

## Change Logs See [change log](docs/change_log.md).

## Documentation The source is available in the [docs](docs) directory.

  • [API Usage](docs/api.md)

## Testing All testing code is under [tests](tests) directory.

After installation, you can run a quick full-functional testing (deploy, invoke, query chaincode, etc.) with your hyperledger cluster by

`python $ python tests/function_test.py HYPERLEDGER_API_URL `

## Contribution Please see [Contribution](CONTRIBUTION.md) and [Contribution Instruction](docs/contribution.md).

## Acknowledgement

This work is highly inspired by the following projects:

## License

This work is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for full license text.

Project details


Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page