Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyperledger/fabric-sdk-py
Hyperledger Fabric Python SDK
https://github.com/hyperledger/fabric-sdk-py
blockchain distributed-ledger fabric hyperledger python
Last synced: about 2 months ago
JSON representation
Hyperledger Fabric Python SDK
- Host: GitHub
- URL: https://github.com/hyperledger/fabric-sdk-py
- Owner: hyperledger
- License: apache-2.0
- Created: 2016-09-11T18:26:24.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-05T11:01:20.000Z (7 months ago)
- Last Synced: 2024-07-03T12:36:56.774Z (3 months ago)
- Topics: blockchain, distributed-ledger, fabric, hyperledger, python
- Language: Python
- Homepage: https://fabric-sdk-py.readthedocs.io/en/latest/
- Size: 7.27 MB
- Stars: 406
- Watchers: 44
- Forks: 203
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- Awesome-Hyperledger-Fabric - Python - Python语言的链访问SDK【英文】 (SDK)
README
# 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/main/docs)!
Recommend to read [How to Contribution](CONTRIBUTING.md) before taking action.
## Other Important Links
* [Fabric SDK Python Wiki](https://wiki.hyperledger.org/display/fabric/Hyperledger+Fabric+SDK+Py)
* [Hyperledger Project](https://www.hyperledger.org)
* [Hyperledger mailing lists](http://lists.hyperledger.org/)
* [Hyperledger's Discord](https://discord.com/servers/hyperledger-foundation-905194001349627914)
## License
The Hyperledger Fabric-SDK-Py software uses the [Apache License Version 2.0](LICENSE) software license.
This document is licensed under a Creative Commons Attribution 4.0 International License.