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

定义 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。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容