Welcome to fabric-sdk-py’s documentation!


Fabric-SDK-Py is the Python 3.x implementation of Hyperledger Fabric SDK. Currently, it mainly supports Fabric 1.4.x version.


The SDK requires Python3 and Libssl packages. Run the following commands 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

Creating a Virtual Evironment

Virtual environment helps providing a clean environment for making changes and testing them locally. Also, it is highly suggested for testing purposes.

$ pip3 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 py3 -- test/integration/ca_test.py  # Run specified test case

Reporting Bug

We welcome any kind of contribution, You can see open issues, requests, code components and also report an issue here.

Ask Questions

We are an opensource community and always welcome your questions. Feel free to ask any question on our community here.

Get started and read our Documentation

You can find our documentation here.

Feel free to contribute

Let’s get started and contribute to Fabric-SDK-Py! You can start here.


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.