快速安装

环境要求

依赖软件

Python环境要求

部署Python SDK

环境要求

初始化环境(若python环境符合要求，可跳过)

Linux环境初始化

拉取源代码

git clone https://github.com/FISCO-BCOS/python-sdk

配置环境

.. note::
   - ``bash init_env.sh -p`` 主要功能是安装pyenv，并使用pyenv安装名称为 ``python-sdk`` 的python-3.7.3虚拟环境
   - 若python环境符合要求，可以跳过此步
   - 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖
   - 安装python-3.7.3可能耗时比较久
   - 此步骤仅需初始化一遍，再次登录直接使用命令 ``pyenv activate python-sdk`` 激活 ``python-sdk`` 虚拟环境即可

# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk
# 若python环境符合要求，可以跳过此步
# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖
# 提示：安装python-3.7.3可能耗时比较久
cd python-sdk && bash init_env.sh -p

# 激活python-sdk虚拟环境
source ~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip

Windows环境初始化

在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：

安装依赖软件

.. note::
    - Microsoft Visual C++ 14.0 is required. Get it with "Microsoft Visual C++ Build Tools"解决方法: https://visualstudio.microsoft.com/downloads （注意选择vs 2005即14.0版）或 https://pan.baidu.com/s/1ZmDUGZjZNgFJ8D14zBu9og 提取码: zrby

    - solc编译器下载成功后，解压，将其中的 ``solc.exe`` 文件复制 ``${python-sdk}\bin`` 目录下，若python-sdk路径为 ``D:\\open-source\\python-sdk`` , 则 ``solc.exe`` 文件复制路径为 ``D:\\open-source\\python-sdk\\bin\\solc.exe``

拉取源代码

打开 git，在任意目录执行如下命令

git clone https://github.com/FISCO-BCOS/python-sdk

配置solc编译器

修改client_config.py.template，配置solc编译器路径，solc二进制下载请参考bcos_solc.py中的描述，并将client_config.py.template拷贝为client_config.py。

# 修改client_config.py.template: 
# 配置solc编译器路径，若solc存放路径为D:\\open-source\\python-sdk\\bin\\solc.exe，则solc_path配置如下：
solc_path = "D:\\open-source\\python-sdk\\bin\\solc.exe"

# 将client_config.py.template拷贝到client_config.py

安装Python SDK依赖

pip install -r requirements.txt

若因网络原因，安装依赖失败，可使用清华的pip源下载，安装命令如下：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt

初始化配置(Windows环境可跳过)

# 该脚本执行操作如下：
# 1. 拷贝client_config.py.template->client_config.py
# 2. 下载solc编译器
bash init_env.sh -i

若没有执行以上初始化步骤，需要将contracts/目录下的sol代码手动编译成bin和abi文件并放置于contracts目录，才可以部署和调用相应合约。合约编译可以使用remix

配置Channel通信协议

Python SDK支持使用Channel协议与FISCO BCOS节点通信，通过SSL加密通信保障SDK与节点通信的机密性。

设SDK连接的节点部署在目录~/fisco/nodes/127.0.0.1目录下，则通过如下步骤使用Channel协议：

配置Channel信息

.. note::
    为便于开发和体验，channel_listen_ip参考配置是 `0.0.0.0` ，出于安全考虑，请根据实际业务网络情况，修改为安全的监听地址，如：内网IP或特定的外网IP

在节点目录下的 config.ini 文件中获取 channel_listen_port, 这里为20200 

[rpc]
    channel_listen_ip=0.0.0.0
    jsonrpc_listen_ip=127.0.0.1
    channel_listen_port=20200
    jsonrpc_listen_port=8545

切换到python-sdk目录，修改 client_config.py 文件中channel_host为实际的IP，channel_port为上步获取的channel_listen_port：

channel_host = "127.0.0.1"
channel_port = 20200

配置证书

# 若节点与python-sdk位于不同机器，请将节点sdk目录下所有相关文件拷贝到bin目录
# 若节点与sdk位于相同机器，直接拷贝节点证书到SDK配置目录
cp ~/fisco/nodes/127.0.0.1/sdk/* bin/

配置证书路径

.. note::
    - ``client_config.py`` 的 ``channel_node_cert`` 和 ``channel_node_key`` 选项分别用于配置SDK证书和私钥
    - ``release-2.1.0`` 版本开始，SDK证书和私钥更新为 ``sdk.crt`` 和 ``sdk.key`` ，配置证书路径前，请先检查上步拷贝的证书名和私钥名，并将 ``channel_node_cert`` 配置为SDK证书路径，将 ``channel_node_key`` 配置为SDK私钥路径
    - FISCO-BCOS 2.5及之后的版本，添加了SDK只能连本机构节点的限制，操作时需确认拷贝证书的路径，否则建联报错

检查从节点拷贝的sdk证书路径，若sdk证书和私钥路径分别为bin/sdk.crt和bin/sdk.key，则client_config.py中相关配置项如下：

channel_node_cert = "bin/sdk.crt"  # 采用channel协议时，需要设置sdk证书,如采用rpc协议通信，这里可以留空
channel_node_key = "bin/sdk.key"   # 采用channel协议时，需要设置sdk私钥,如采用rpc协议通信，这里可以留空

若sdk证书和私钥路径分别为bin/node.crt和bin/node.key，则client_config.py中相关配置项如下:

channel_node_cert = "bin/node.crt"  # 采用channel协议时，需要设置sdk证书,如采用rpc协议通信，这里可以留空
channel_node_key = "bin/node.key"   # 采用channel协议时，需要设置sdk私钥,如采用rpc协议通信，这里可以留空

使用Channel协议访问节点

.. note::
    windows环境下执行console.py请使用 ``.\console.py`` 或者 ``python console.py``

# 获取FISCO BCOS节点版本号
./console.py getNodeVersion

开启命令行自动补全

Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)

.. note::

    - 此步骤仅需设置一次，设置之后以后每次登陆自动生效
    - 请在 **bash环境** 下执行此步骤
    - 目前仅支持bash，不支持zsh 

echo "eval \"\$(register-python-argcomplete ./console.py)\"" >> ~/.bashrc
source ~/.bashrc