基于 Python SDK 的配置及打包

SDK 打包

setuptools 工具包安装

默认情况下创建工程时默认都会装好，若是没有可以自行安装

pip install setuptools

创建打包目录结构

├─python-sdk
│  │  README.md
│  │  setup.py
│  └─MySdk
      |  my_sdk.py
      │  __init__.py
|

目录说明：

• python-sdk 代表的是sdk根目录
• README.md 介绍本sdk的使用方法及sdk的能力
• setup.py 用于打完包后，调用者要使用该文件进行安装sdk到自己的python环境中
• my_log 是您所提供能力的封装

本样例中的__init__.py 文件内容是自行封装的类，内容如下

#!/usr/bin/env python
# _*_ coding:utf-8 _*_
# DevVersion: Python3.6.8
# Date: 2020-09-25 09:04
# PyCharm|__init__.py

from MySdk.my_sdk import SdkMiddleware

配置 setup.py 文件

#!/usr/bin/env python
# _*_ coding:utf-8 _*_
# DevVersion: Python3.6.8
# Date: 2020-09-25 09:13
# PyCharm|setup

from setuptools import (setup, find_packages)

setup(
    # 包名
    name="MySdk",
    # 版本
    version="0.1",
    # github地址[我学习的样例地址]
    url='https://github.com/snowroll/python-sdk.git',
    # 包的解释地址
    long_description=open('ReadMe.md', encoding='utf-8').read(),
    # 需要包含的子包列表
    packages=find_packages()
)

配置说明：

• name：包的名字
• version：依赖关系很重要
• packages：需要包含的子包列表，用find_packages()查找
• url：包的链接，通常为 Github 上的链接，或者是 readthedocs 链接
• setup_requires：指定依赖项
• test_suite：测试时运行的工具

执行打包

执行后会生成build、demo.egg-info 、dist三个目录

python setup.py bdist_egg

调用 SDK

1. 将需要用到上面 sdk 的工程中，解压该sdk并复制到您的工程中
2. 切换到 setup.py 文件目录下即 sdk 的根目录，然后像安装离线包一样，执行命令python setup.py install 安装MySdk包
3. 调用该包

import MySdk
sdk = MySdk.SdkMiddleware(app_name="test_app", log_when="S", sdk_dir_path=os.path.dirname(os.path.abspath(__file__)))