不使用setup.py,打包 Python 项目
off999 2024-09-16 00:52 31 浏览 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/
译者:一瞬
相关推荐
- 阿里云国际站ECS:阿里云ECS如何提高网站的访问速度?
-
TG:@yunlaoda360引言:速度即体验,速度即业务在当今数字化的世界中,网站的访问速度已成为决定用户体验、用户留存乃至业务转化率的关键因素。页面加载每延迟一秒,都可能导致用户流失和收入损失。对...
- 高流量大并发Linux TCP性能调优_linux 高并发网络编程
-
其实主要是手里面的跑openvpn服务器。因为并没有明文禁p2p(哎……想想那么多流量好像不跑点p2p也跑不完),所以造成有的时候如果有比较多人跑BT的话,会造成VPN速度急剧下降。本文所面对的情况为...
- 性能测试100集(12)性能指标资源使用率
-
在性能测试中,资源使用率是评估系统硬件效率的关键指标,主要包括以下四类:#性能测试##性能压测策略##软件测试#1.CPU使用率定义:CPU处理任务的时间占比,计算公式为1-空闲时间/总...
- Linux 服务器常见的性能调优_linux高性能服务端编程
-
一、Linux服务器性能调优第一步——先搞懂“看什么”很多人刚接触Linux性能调优时,总想着直接改配置,其实第一步该是“看清楚问题”。就像医生看病要先听诊,调优前得先知道服务器“哪里...
- Nginx性能优化实战:手把手教你提升10倍性能!
-
关注△mikechen△,十余年BAT架构经验倾囊相授!Nginx是大型架构而核心,下面我重点详解Nginx性能@mikechen文章来源:mikechen.cc1.worker_processe...
- 高并发场景下,Spring Cloud Gateway如何抗住百万QPS?
-
关注△mikechen△,十余年BAT架构经验倾囊相授!大家好,我是mikechen。高并发场景下网关作为流量的入口非常重要,下面我重点详解SpringCloudGateway如何抗住百万性能@m...
- Kubernetes 高并发处理实战(可落地案例 + 源码)
-
目标场景:对外提供HTTPAPI的微服务在短时间内收到大量请求(例如每秒数千至数万RPS),要求系统可弹性扩容、限流降级、缓存减压、稳定运行并能自动恢复。总体思路(多层防护):边缘层:云LB...
- 高并发场景下,Nginx如何扛住千万级请求?
-
Nginx是大型架构的必备中间件,下面我重点详解Nginx如何实现高并发@mikechen文章来源:mikechen.cc事件驱动模型Nginx采用事件驱动模型,这是Nginx高并发性能的基石。传统...
- Spring Boot+Vue全栈开发实战,中文版高清PDF资源
-
SpringBoot+Vue全栈开发实战,中文高清PDF资源,需要的可以私我:)SpringBoot致力于简化开发配置并为企业级开发提供一系列非业务性功能,而Vue则采用数据驱动视图的方式将程序...
- Docker-基础操作_docker基础实战教程二
-
一、镜像1、从仓库获取镜像搜索镜像:dockersearchimage_name搜索结果过滤:是否官方:dockersearch--filter="is-offical=true...
- 你有空吗?跟我一起搭个服务器好不好?
-
来人人都是产品经理【起点学院】,BAT实战派产品总监手把手系统带你学产品、学运营。昨天闲的没事的时候,随手翻了翻写过的文章,发现一个很严重的问题。就是大多数时间我都在滔滔不绝的讲理论,却很少有涉及动手...
- 部署你自己的 SaaS_saas如何部署
-
部署你自己的VPNOpenVPN——功能齐全的开源VPN解决方案。(DigitalOcean教程)dockovpn.io—无状态OpenVPNdockerized服务器,不需要持久存储。...
- Docker Compose_dockercompose安装
-
DockerCompose概述DockerCompose是一个用来定义和管理多容器应用的工具,通过一个docker-compose.yml文件,用YAML格式描述服务、网络、卷等内容,...
- 京东T7架构师推出的电子版SpringBoot,从构建小系统到架构大系统
-
前言:Java的各种开发框架发展了很多年,影响了一代又一代的程序员,现在无论是程序员,还是架构师,使用这些开发框架都面临着两方面的挑战。一方面是要快速开发出系统,这就要求使用的开发框架尽量简单,无论...
- Kubernetes (k8s) 入门学习指南_k8s kubeproxy
-
Kubernetes(k8s)入门学习指南一、什么是Kubernetes?为什么需要它?Kubernetes(k8s)是一个开源的容器编排系统,用于自动化部署、扩展和管理容器化应用程序。它...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)
