Skip to main content

Python SDK for Hyperledger Fabric.

Project description

# Fabric-SDK-Py

Note: This is a read-only mirror of the [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/fabric-sdk-py) repository, where active development is ongoing.

Fabric-SDK-Py is an implementation of the Hyperledger fabric SDK in Python 3.x!

## Incubation Notice

This project is in [_Incubation_](https://goo.gl/4edNRc) now, and was [proposed](https://docs.google.com/document/d/1N-KbwlFb7Oo_pTG2NjjLTqwlhqp_kjyv5fco7VH8WrE/) and [approved](http://lists.hyperledger.org/pipermail/hyperledger-tsc/2016-September/000292.html) by Hyperledger TSC at Sep 08, 2016.

## Bug, Question and Code Contributions Welcome for any kind of contributions, e.g., [bugs](https://jira.hyperledger.org/browse/FABP-164?jql=project%20%3D%20FABP%20AND%20status%20in%20(%22In%20Progress%22%2C%20%22To%20Do%22)%20), [questions](https://chat.hyperledger.org/channel/fabric-sdk-py) and [documentation](https://github.com/hyperledger/fabric-sdk-py/tree/master/docs)!

Recommend to read [How to Contribution](CONTRIBUTING.md) before taking action.

## Pre-requisite

The SDK requires the python-dev and libssl-dev pkgs.

Run the following cmd to install the pre-requisites:

OS | command |
– | ———- |
Ubuntu/Debian | sudo apt-get install python-dev python3-dev libssl-dev |
Redhat/CentOS | sudo yum install python-devel python3-devel openssl-devel |
MacOS | brew install python python3 openssl |

More details to build the crypto lib, can be found at

## Tutorial

See [Tutorial](docs/tutorial.md) to get familiar with the major SDK APIs.

## Quick Testing

### Use Virtual Env

[virtualenv](https://virtualenv.pypa.io) helps provide a clean environment, suggest to use it to test.

`sh $ pip install virtualenv # install the virtualenv tool if not installed $ make venv # create a virtual env $ source venv/bin/activate $ # Do the testing here $ deactivate # deactive the virtual env $ make clean # clean the temporary files `

### Run Integration Testing The following command will run the testing. `sh $ make check # Check environment and run tests $ make test # Only run test cases $ tox -e py30 -- test/integration/ca_test.py # Run specified test case `

## Generating Docker images The following command will build the Docker image hyperledger/fabric-sdk-py.

`sh $ make image `

## Regenerating protos

Make sure you have grpcio-tools installed (pip install grpcio-tools) `sh make proto `

## Change Logs See [Change Log](CHANGELOG.md) for the commit logs. Run make changelog to update the changelog before new release.

## Other Important Links

## License <a name=”license”></a> The Hyperledger Fabric-SDK-Py software uses the [Apache License Version 2.0](LICENSE) software license.

<a rel=”license” href=”http://creativecommons.org/licenses/by/4.0/”><img alt=”Creative Commons License” style=”border-width:0” src=”https://i.creativecommons.org/l/by/4.0/88x31.png” /></a><br />This document is licensed under a <a rel=”license” href=”http://creativecommons.org/licenses/by/4.0/”>Creative Commons Attribution 4.0 International License</a>.

Project details


Download files

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

Source Distribution

fabric-sdk-py-0.8.1.tar.gz (158.6 kB view details)

Uploaded Source

Built Distribution

fabric_sdk_py-0.8.1-py3-none-any.whl (247.7 kB view details)

Uploaded Python 3

File details

Details for the file fabric-sdk-py-0.8.1.tar.gz.

File metadata

  • Download URL: fabric-sdk-py-0.8.1.tar.gz
  • Upload date:
  • Size: 158.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3

File hashes

Hashes for fabric-sdk-py-0.8.1.tar.gz
Algorithm Hash digest
SHA256 1641bc0660dfe2b95a0b8e1cf51844304c9cf8af6989ba0b2577160e1f1da51a
MD5 71f40e4e503754d5636f19ad6f27faad
BLAKE2b-256 880b91d70c551da12164e85ddfe85c06c99222a695049a3b7ae644b235cacb92

See more details on using hashes here.

File details

Details for the file fabric_sdk_py-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: fabric_sdk_py-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 247.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3

File hashes

Hashes for fabric_sdk_py-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65b1cc9d626dd50dae2c5382b80f12cf7d72b18a13454e4521d888610cc9ab2a
MD5 307cbdd20fc55d90da9b75a2082f1b85
BLAKE2b-256 5a09c913ecb702cae87cdaa7a899f3bdae357aca9eabaef52488d2041b491896

See more details on using hashes here.

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