czone-league / fabric-sdk-py

Read-only mirror of https://gerrit.hyperledger.org/r/#/admin/projects/fabric-sdk-py

Fabric-SDK-Py

Note: This is a read-only mirror of the formal Gerrit repository, where active development is ongoing.

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

Incubation Notice

This project is a Hyperledger project in Incubation. It was proposed to the community and documented here, and was approved by Hyperledger TSC at 2016-09-08. Information on what Incubation entails can be found in the Hyperledger Project Lifecycle document.

Bug, Question and Code Contributions

Welcome for any kind of contribution, including bugs, questions and documentation!

Please see How to Contribution.

Coding Style

We're following pep8 style guide and Google style, please see coding style

Pre-requisite

The SDK requires the python-dev and libssl-dev pkgs, so please make sure it's already installed.

Run the following cmd according to ur OS type.

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

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 a Docker image hyperledger/fabric-sdk-py with the fabric-sdk-py installed.

$ make image

Also, you can use docker-compose to start a cluster for testing, including fabric-peer, fabric-orderer, fabric-ca, and fabric-sdk-py containers.

$ docker-compose up -d
$ docker exec -it fabric-sdk-py bash

Change Logs

See Change Log.

Wiki

More information, please see the project wiki.

About Hyperledger Project

• Hyperledger Project
• Hyperledger mailing lists and archives
• Hyperledger Chat
• Hyperledger Wiki

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.