百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

不使用setup.py,打包 Python 项目

off999 2024-09-16 00:52 36 浏览 0 评论

我编写了许多开源项目,并允许其他人通过PyPI访问这些项目。为此,我需要从这些项目构建一个源代码分发版(sdist)和一个可选的wheel包,并将二者上传到PyPI。最后,这个sdist和wheel包必须要能通过pip进行安装,以便其他人使用。

我的大多数项目使用setuptools(通过一个setup.py)进行打包,因为这是长久以来实现此目的的(唯一)方法,但是,最近的两个PEP(517和518)允许我们开发新的工具。最值得注意的是,这些新工具使用了一个pyproject.toml文件,你可以在这篇文章中了解有关它的更多信息。

一段时间以来,我一直在使用这些新工具中的一种,Poetry,来管理我的应用程序。最初,我这样做是受Poetry's的文件锁支持所鼓舞的,它优于我之前使用的requirements-to-freeze系统。还有一个原因是poetry允许执行脚本,比如poetry run test,我在这篇文章中解释过。

因为我喜欢在我的应用程序中使用Poetry,所以我想我应该在我的一个库(Quart- Auth)上尝试一下,Quart- Auth是Quart的一个身份验证管理扩展。这是我正在实验的一些东西,但是我已经对下面的设置很满意了。

Setup.py 设置

由于我的项目是纯python的(没有用c代码来编译),构建要简单得多,唯一的复杂之处是我希望按照PEP 561包含一个py.typed文件。我的设置需要一个MANIFEST.in和一个 setup.py,并且关键的是使用check-manifest工具和python setup.py check来确保一切都是正确的。

来自Quart-Rate-Limiter的一个示例setup.py文件(精简至关键部分)是,

一个示例MANIFEST.in文件(同样进行了精简) 是:

Setup.py 发布过程

要构建sdist、wheel并将其推送到PyPI,一个安装了setuptools、whee和twine的环境是必需的。然后你就可以使用以下命令去构建和上传,

Poetry 设置

Poetry包含了一个方便的命令来允许你使用poetry new从头设置一个项目或者使用poetry init在现有的项目中设置一个项目。这个命令会创建pyproject.toml文件,其中包含了继续进行项目所需的足够的信息。对于Quart-Auth,我添加了一个分类器列表、存储库url、依赖项(包括用于开发的tox),并指出py.typed文件应该在构建包中,请在这里查看该文件。

就我所知,这就是所有需要设置的东西。我们现在就可以使用poetry构建Quart-Auth了。

Poetry发布

要构建sdist、wheel并将其推送到PyPI,一个安装了poetry和wheel的环境是必需的。然后你就可以使用以下命令去构建和上传,

补充:包版本用法

通常情况下,例如在Quart & Flask中,版本存储在源代码中,该代码会在setup.py中被加载或解析。

这就允许库用户以编程方式查询版本(例如quart.__about__.__version__)。这在poetry设置中显然是不可能的,但是在Python3.8中有一个更好的解决方案,

一个示例用法是当你在构建Quart-Auth文档的时候。

结论

只使用pyproject和poetry而不使用setuptools有一个重要的缺点,那就是可编辑安装,例如,pip install -e ..在没有shim的情况下是不可能执行的,看看这个讨论。这就暂时排除了在我所维护的Quart 和 Hypercorn项目中使用Poetry的可能性。

切换到poetry和pyproject.toml就意味着我距离为我的项目设置一个更简单、更清晰的配置这个目标更近了一步,即pyproject.toml中的所有东西。当我有时间的时候,我可能会转移更多的项目。

英文原文:https://pgjones.dev/blog/packaging-without-setup-py-2020/
译者:一瞬

相关推荐

路由器初始密码忘了怎么办(路由器忘记原始密码怎么办)

路由器密码忘了可以通过恢复出厂设置重新设置密码1、把所有网线都从路由器上拔掉,只保留电源线既可;    2、然后用稍尖的笔尖刺紧路由器背面的“RESET”小孔不放;    3、有的是“RESET”...

hotmail邮箱还能用吗(hotmail邮箱登录有手机客户端的吗)

这个是可以重新申请的呢除了谷歌国内受限,其他基本都可以正常使用。看个人使用习惯可自主申请相应邮箱:微软outlook、hotmail邮箱;网易邮箱、网易126邮箱;新浪邮箱、阿里邮箱;QQ邮箱、搜狐...

怎么建立局域网(怎么建立局域网内其他电脑文件夹的快捷方式)
  • 怎么建立局域网(怎么建立局域网内其他电脑文件夹的快捷方式)
  • 怎么建立局域网(怎么建立局域网内其他电脑文件夹的快捷方式)
  • 怎么建立局域网(怎么建立局域网内其他电脑文件夹的快捷方式)
  • 怎么建立局域网(怎么建立局域网内其他电脑文件夹的快捷方式)
diskdigger官网入口(diskinfo官网)

打开LaunchCenterPro,创建一个叫Omnifocus的操作组,然后再往这个操作组添加新的操作。如果你要在Omnifocus创建新收件箱项,添加URL到LaunchCenter...

最新英特尔处理器排名(最新英特尔处理器排名第几)

一、英特尔酷睿i7670。这款英特尔CPU采用的是超频新芯,最大程度的提升处理器的超频能力。二、英特尔酷睿i74790kCPU:这款CPU采用22纳米制程工艺的框架,它的默认频率是4.0到4.4Ghz...

电脑怎样激活win10系统(电脑怎么激活window10)
  • 电脑怎样激活win10系统(电脑怎么激活window10)
  • 电脑怎样激活win10系统(电脑怎么激活window10)
  • 电脑怎样激活win10系统(电脑怎么激活window10)
  • 电脑怎样激活win10系统(电脑怎么激活window10)
nvidia旧版本驱动下载(nvidia新版本驱动)
nvidia旧版本驱动下载(nvidia新版本驱动)

没法装,n卡本身不具备装旧版驱动的功能一、首先在本机电脑内鼠标左键双击打开“驱动人生”(若电脑上无此软件,可以在各大软件市场内下载安装)。二、打开驱动人生软件后,点击“立即体检”进行驱动扫描。三、驱动扫描完成后,点击显卡右边的“箭头”打开驱...

2025-12-18 20:51 off999

怎么解开别人的wifi密码(如何解开别人的wifi密码)

别人的无线网络密码是很不容易破解的,如果人家是愿意分享的,可以在手机上下载"Wifi万能钥匙"注册登陆成功后连接其无线wifi1、以现有的技术手段,是没有办法破解WPA的加密方式(现在...

电脑突然关机(电脑突然关机像断电了一样 再也打不开)
电脑突然关机(电脑突然关机像断电了一样 再也打不开)

如果是插电源的电脑开着突然就关机了,可能是线路接触不良或者是没电了,导致的开着就关机了,如果是你的电脑是充电的那一种可能是你的电池的电量用完了或者是电池的线路接触不良导致的开着突然就关机了,你可以排查一下线路。1、如果你使用的是笔记本电脑,...

2025-12-18 19:51 off999

win7重装系统一直反复重启(win7重装系统无限重启)

WIN7的系统装重复了,可以将原安装的系统删除,方法如下:1、如果以前的windows是安装在C盘上的话,点击桌面上的计算机,选中C盘,鼠标右键选择属性;2、点磁盘清理;3、点清理系统文件,点确定;4...

电脑如何格式化sd卡(电脑格式化sd卡,提示写有保护)

要在电脑上格式化SD卡,可以按照以下步骤:1.将SD卡插入计算机的SD卡读卡器中。2.打开“我的电脑”或“此电脑”,找到SD卡在计算机上的驱动器号(比如E盘)。3.右键单击SD卡驱动器,选择“格...

系统检测不到机械硬盘(系统检测不到机械硬盘怎么办)

第一,我们需要确认一下机械硬盘是否连接正常。可以检查一下硬盘的电源线和数据线是否插紧,是否松动或者断开。如果发现有松动或者断开的情况,可以重新插上并确保插紧。如果硬盘连接正常,但电脑仍然无法读取,那么...

路由器管理平台登录(路由器管理平台登录网址)

路由器的用户登录入口地址是:tplogin.cn电信运营商定制款登录地址是:192.168.2.1或者192.168.8.12、华为(容易)路由器华为路由器跟荣耀路由器只有IP地址,没有域名,它是...

directx修复(DirectX修复工具官网下载)

使用DirectX修复工具很简单。首先需要下载并安装工具,然后打开工具并按照界面提示进行操作即可。工具的作用是自动检测系统中可能存在的DirectX问题,并尝试修复它们,从而保证计算机游戏等应用程序的...

网易邮箱app官方下载安装(网易邮箱163)
网易邮箱app官方下载安装(网易邮箱163)

有些东西调用外部下载软件(如迅雷)是无法下载的,有时下载后不能正常打开,请尝试:在所要下载的文件上点击右键,选择“目标另存为”,也许就能成功下载。下载从网易163邮箱发来的云附件的步骤如下:1.成功登录网易邮箱后,我们点击页面左上角的“收件...

2025-12-18 16:51 off999

取消回复欢迎 发表评论: