Skip to main content

# Fabric-SDK-Py

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

Currently, it mainly supports Fabric 1.4.x version.

## Pre-requisite

The SDK requires the Python3 and Libssl pkgs.

Run the following cmd to install the pre-requisites if you do not have:

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 [Install Python Cryotography Lib](https://cryptography.io/en/latest/installation).

## Tutorial

Read the [Tutorial](https://fabric-sdk-py.readthedocs.io/en/latest/tutorial.html) ([Source](docs/source/tutorial.md)) to get familiar with the APIs. A jupyter notebook explaining the sample code can be found [here](Tutorial.ipynb).

## Quick Testing

### Use Virtual Env

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

`sh $ 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. `sh $ 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 `

## 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.

## Bug, Question and Code Contributions Welcome for any kind of contributions, e.g., [bugs](https://jira.hyperledger.org/projects/FABP), [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.

## Other Important Links

## 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.

## 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>.

Release files for fabric-sdk-py 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fabric-sdk-py 1.0.0
File Size Uploaded
fabric-sdk-py-1.0.0.tar.gz 165.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fabric-sdk-py 1.0.0
File Interpreter ABI Platform
fabric_sdk_py-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 428.7 kB

Release files / fabric-sdk-py-1.0.0.tar.gz

Download URL fabric-sdk-py-1.0.0.tar.gz
Size 165.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0727043506f6821039f48316bca6f1fa8980f04cbccdf7dc6687a1074db52022
BLAKE2b-256 checksum
How to use checksums
7a61e2449e8a29c89723b5e825ba44071893a208c2c5518719607a8b9cb932a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9

Release files / fabric_sdk_py-1.0.0-py3-none-any.whl

Download URL fabric_sdk_py-1.0.0-py3-none-any.whl
Size 263.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
00e13787c078f5b0823efa4f3f259e7ce45dc901246a8bccfe1f05d119f7538d
BLAKE2b-256 checksum
How to use checksums
17ef5bb42e639af3a4fea9fcc75d4faa5d57476b4170b2870e72e66093118809
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.8.1

2 release files

0.8.0

1 release file

0.0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page