README
¶
Fabric-SDK-Py
Note: This is a read-only mirror of the Gerrit 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 now, and was proposed and approved by Hyperledger TSC at Sep 08, 2016.
Bug, Question and Code Contributions
Welcome for any kind of contributions, e.g., bugs, questions and documentation!
Recommend to read How to Contribution 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
- https://cryptography.io/en/latest/installation/#building-cryptography-on-linux
- https://cryptography.io/en/latest/installation/#building-cryptography-on-macos
Tutorial
See Tutorial to get familiar with the major SDK APIs.
Quick Testing
Use Virtual Env
virtualenv helps provide a clean environment, suggest to use it to test.
$ 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.
$ 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.
$ make image
Regenerating protos
Make sure you have grpcio-tools installed (pip install grpcio-tools)
make proto
Change Logs
See Change Log for the commit logs. Run make changelog to update the changelog before new release.
Other Important Links
License
The Hyperledger Fabric-SDK-Py software uses the Apache License Version 2.0 software license.
This document is licensed under a Creative Commons Attribution 4.0 International License.
Directories