Python SDK(软件开发工具包)并将其推送至仓库以打成可用

2024-04-23  本文已影响0人  ljh_10e3

定义 SDK 的功能和接口:明确 SDK 提供的功能和 API。

编写代码实现功能:使用 Python 编写实现 SDK 功能的代码。

组织代码结构:将代码合理地组织到模块和文件中。

编写文档:提供清晰的文档,说明 SDK 的用法和功能。

创建 setup.py 文件:用于配置打包信息。

使用 setuptools 或 poetry 等工具打包:根据设置.py 文件进行打包。

测试打包后的模块:确保其在不同环境下正常工作。

将包推送至仓库:例如 PyPI(Python Package Index)。

在项目中使用可用包:其他开发者可以通过安装该包来使用其功能。

以下是一个简单的示例,展示了如何创建一个基本的 Python SDK 并将其打包为可用包:

首先,创建一个名为 my_sdk 的目录,并在其中创建以下文件:

__init__.py:这是一个空文件,用于标识这是一个 Python 模块。

function.py:包含 SDK 的功能实现。

function.py 的内容可能如下:

def add_numbers(a, b):

    return a + b

然后,创建 setup.py 文件,内容如下:

from setuptools import setup

setup(

    name='my_sdk',

    version='0.1.0',

    description='A simple SDK for adding numbers',

    author='Your Name',

    author_email='your_email@example.com',

    packages=['my_sdk']

)

接下来,使用以下命令打包 SDK:

    python setup.py sdist

这将创建一个 dist 目录,其中包含打包后的文件。

要将包上传到 PyPI,你需要注册一个账户并遵循 PyPI 的上传流程。

在其他项目中,可以使用 pip 安装这个包:

    pip install my_sdk

然后,你就可以在项目中导入并使用 my_sdk 中的功能,例如:

from    my_sdk    import    add_numbers

    result=add_numbers(3,5)

    print(result)

具体上传,可用账户token在macos本地目录下建立.py 配置账户和token

[distutils]

index-servers=

    pypi:

        username = your_username

        password = your_token

.pypirc 文件通常放在以下位置:

在用户的主目录下。

将.pypirc 文件放在这个位置后,上传命令会自动找到并使用该文件中的配置信息。

而 dist 文件夹是用于存储打包后的文件的地方。

在执行 python setup.py sdist bdist_wheel 命令后,会生成打包后的文件,并放置在 dist 文件夹中。

然后,使用 python -m twine upload dist/* 命令将 dist 文件夹中的文件上传到 PyPI。

对了 环境包记得装,pip install setuptool  twine wheel

然后执行 

 python setup.py sdist bdist_wheel 

python -m twine upload dist/*

注意:python setup.py sdist bdist_wheel 命令用于创建分布包(sdist)和 Wheel 格式的包。

Wheel 格式是一种更优化的包格式,它可以提高安装速度。

然后,使用 python -m twine upload dist/* 命令将生成的包上传到 PyPI。

上一篇 下一篇

猜你喜欢

热点阅读