使用Setuptools构建Python软件包

翻译转自Ayush_Singhal

在此博客中,我们将使用Setuptools创建源代码发行版和python包wheel。在走向如何包装之前。首先让我们了解什么是源代码分发和wheel文件。

包是指可以提供以解决特定用例的可用单元或库。对于打包,我们有不同的构建工具,例如在Scala中有SBT或在JAVA中有maven等。类似地,我们在python中有Setuptools来创建发行版。源代码分发(sdist)和Wheels(whl)是在python中创建软件包分发的两种主要方法。

源代码分发(sdist):除源代码外,它还包含额外的文件(例如CI脚本,测试用例等),这些文件不需要提供给最终用户和使用最少的方法。这将以不同的格式分发包,以针对不同平台的不同格式创建档案。默认格式是.tar.gzLinux上的压缩tar文件()和Windows上的ZIP文件。

Wheels(whl):此发行版包含安装所需的源文件和程序包元数据。(.whl)

setup.py

  1. 该文件包含setup()函数,我们在其中提供您项目的特定详细信息。其中包含诸如包名称,版本,要求包,作者,描述,分类器等信息。
  2. 它是命令行界面,用于运行与打包任务有关的各种命令。如果您想进一步研究,只需运行python setup.py –help
    python包装的图像结果

对于项目结构,我使用以下结构:

dummy_project/
|-- README
|-- setup.py
|-- example_pkg
|   |-- __init__.py
|   |-- calculate.py
|   |-- result.py
|-- tests
|-- |-- __init__.py
|-- |-- run.py
|-- |-- test.py

让我们创建最重要的文件setup.py,该文件位于项目目录的根目录下。

from setuptools import setup

setup(
    name = "dummy_project",
    version = "1.0.0",
    author = "dummy",
    author_email = "dummy@domain.com",
    description = ("This project helps to understand about setup.py."),
    url = "https://www.python.org/doc/",
    packages=['example_pkg'],
    python_requires='>=3.6.0'
)

现在,让我们使用以下命令创建一个发行版

python setup.py sdist bdist_wheel

这将生成两个分布。现在,根据您的用例,您可以将您的软件包推送到公共或私有python存储库中。可以通过pip命令安装,如下所示:

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