当前位置: 首页 > 工具软件 > Python_sdk > 使用案例 >

python SDK打包教程(一)

燕经国
2023-12-01

这两天一直在学习python 封装SDK的方法,最开始师兄给了几个SDK的样例项目,表示太复杂,完全没有看懂。幸好,找到了几个不错的博客,带我这个小白入门,在这里总结一下。

参考博文:

python-sdk-demo的打包

一文教会你正确打包python程序

1. 首先,我们需要一个工具包来协助我们完成python打包的任务

 pip install python-setuptools

2. 之后封装好你的项目api

一个简单的项目示例。https://github.com/snowroll/python-sdk.git

目录结构

├─python-sdk
│  │  README.md
│  │  setup.py
│  └─Demo

│          __init__.py

Demo/__init__.py中只有一个输出函数demo(),这里可以自行封装自己的api

3.编写setup.py文件,用于安装Demo包
#!/usr/bin/env python
#-*- coding:utf-8 -*-

from setuptools import setup, find_packages

setup(
	name = "demo",
	version = "0.1",
	url = 'https://github.com/snowroll/python-sdk.git',
	long_description = open('README.md').read(),
	packages = find_packages(),
)

从setuptools中导入setup和findpackages,各参数的含义如下:

name:               包的名字
version:            版本号,对保持适当的依赖关系很重要
packages:           需要包含的子包列表,用find_packages()查找
url:               包的链接,通常为 Github 上的链接,或者是 readthedocs 链接
long_description:  将说明文件设置为README.md
4. 创建一个简单的包

执行python setup.py bdist_egg即可打包一个Demo的包

会生成build、demo.egg-info 、dist三个目录,将python-sdk目录打包,发给调用方

5. 安装和使用SDK

解压进入该目录下,运行 python setup.py install 安装Demo包。

之后打开python命令行,尝试调用Demo包

>>> import Demo
>>> Demo.demo()
simple sdk demo




 类似资料: