Python SDK 模块开发与发布全流程指南

一只小鹿

发布时间：2026-10-15| 4人浏览过

原创

本文详细讲解Python SDK模块的开发、打包与发布流程。从编写setup.py配置文件开始，介绍如何依赖requirements.txt管理依赖，通过pip安装必要工具后在虚拟环境中执行安装命令。同时涵盖将模块上传至PyPI或私有仓库的方法，以及常见报错如egg_info失败的解决方案，帮助开发者高效构建安全高效的Python第三方模块。

一、开发模块目的

通过 setup.py 将框架安装到 Python 环境中，将其开发为第三方模块进行调用，以此提升使用的便捷性、安全性及运行效率。

二、编写 setup.py 文件

#!/usr/bin/env python
import os
from setuptools import (
    find_packages,
    setup,
)
 
path = '/home/server/wangm/gfdatasdk/requirements.txt'
file_path = path if path else os.path.join( os.getcwd(), 'requirements.txt')
 
 
def parse_requirements(filename):
    """
    加载requirements文件
    Args:
        filename:
    Returns:
    """
    requirements = (line.strip() for line in open(filename))
    return [require for require in requirements if require and not require.startswith("#")]
 
 
setup(
    name='datasdk',
    version='1.0.0',
    description='  package',
    packages=find_packages(exclude=['tests', 'tests.*']),
    url=' ******',
    author='gfzq',
    author_email='1115201185@qq.com',
    install_requires=parse_requirements(file_path),
)

三、安装自研模块

pip install packaging
pip install --upgrade setuptools
切换到对应的 Python 虚拟环境
进入 setup.py 所在的目录
在终端执行命令 python setup.py install

四、遇到问题

五、运营及维护

通常将开发的 SDK 自研模块存放于 PyPI 仓库，以便所有人方便地上传和下载。PyPI 是 Python 官方的第三方库仓库，允许用户下载第三方库或上传自己开发的库。PyPI 推荐使用 pip 包管理器来下载第三方库，pip 可正常工作在 Windows、Mac OS、Unix/Linux 等操作系统上。