新闻资讯  快讯  焦点  财经  政策  社会
互 联 网   电商  金融  数据  计算  技巧
生活百科  科技  职场  健康  法律  汽车
手机百科  知识  软件  修理  测评  微信
软件技术  应用  系统  图像  视频  经验
硬件技术  知识  技术  测评  选购  维修
网络技术  硬件  软件  设置  安全  技术
程序开发  语言  移动  数据  开源  百科
安全防护  资讯  黑客  木马  病毒  移动
站长技术  搜索  SEO  推广  媒体  移动
财经百科  股票  知识  理财  财务  金融
教育考试  育儿  小学  高考  考研  留学
您当前的位置:首页 > IT > 程序开发 > 语言 > Python

用 Poetry 创建并发布 Python 包

时间:2019-06-14 10:44:15  来源:  作者:
用 Poetry 创建并发布 Python 包

 

如果您曾经使用setup.py脚本发布过一个python包,那么您可能会发现编写脚本来发布包比编写包本身要困难。

Python 开发人员认识到了这一点,并且有一些工具采用了一种更现代的方法来构建包。Poetry 和 Flit 是构建Python 包的两种流行工具。

(此处已添加圈子卡片,请到今日头条客户端查看)

因为我使用了Poetry作为一个Python依赖性管理工具,所以我决定玩转它的包管理功能。

为了获得使用Poetry发布包的实践经验,我最近发布了Flake8 Markdown,一个用 Flake8 在Markdown文件中lint Python 代码的工具。

本文将介绍我对Flake8 Markdown的pyproject.toml和codebase所做的更改,以使其可以在 PyPI(python包索引)上发布。

信息 已发布版本请查看Flake8 Markdown 仓库。

创建一个包

用 Poetry 创建一个包, 如果 Poetry 已安装,是会有帮助的。要做到这一点,请遵循 Poetry 安装说明。现在,用Poetry 创建一个包,我们将运行 poetry new,并提供包含该包的目录的名称:

用 Poetry 创建并发布 Python 包

 

我们收到邮件了! 不管怎样,我们有一个包裹 (package,双关语---译者注)。让我们打开它:

用 Poetry 创建并发布 Python 包

 

开箱即用,Poetry为我们提供了一个简单的包结构和 pyproject.toml 文件:

  • 0.1.0的包版本
  • Python 的最小版本(在我的例子中是^3.7)
  • pytest 支持和一个单元测试
信息关于 pyproject.toml的信息和背景,见 PEP 518。

如果我们将这个包按原样发布在 Python包索引(PyPI)上,那么这个包看起来就不怎么样,所以让我们让它看起来像值得安装的东西。

自定义包

以下是初始 pyproject.toml文件:

用 Poetry 创建并发布 Python 包

 

以下是完成的 pyproject.toml:

用 Poetry 创建并发布 Python 包

 

信息有关自定义Poetry包的可用部分的完整列表,请参阅 Poetry's pyproject.toml 文档。 让我们从上到下逐步进行更改。

version

Version 描述了一个包的当前版本。我尝试遵循语义版本控制,所以当更新向后不兼容时很明显。

注一旦一个包的版本存在于pypi上,就不可能使用相同的版本号上传不同的代码。在发布Pypi上的版本之前,请确保使用 TestPyPI 进行测试更改。

description

这个简短的描述出现在 pip search 和 PyPI搜索结果 中。

license

许可证出现在包的 PyPI 页面的“Meta”部分。

我用 Github 的 choosealicense.com 找到了一个合适的许可证,并选定 MIT。Poetry 还列出了其他常见的许可证 和推荐的记号。

readme

Poetry创建了一个 README.rst 文件,但我更喜欢用 Markdown 编写文档。 README 的内容在 PyPI 上显示为项目描述,因此很好地解释为什么以及如何使用你的包。 我的 README 包括:

  • 盾牌(因为它们看起来很漂亮)
  • 引言
  • 安装
  • 使用
  • 行为准则
  • 历史记录(大致遵循保留一个变更日志)

homepage and repository

这些出现在包的 PyPI 页面的 Project 链接部分:

用 Poetry 创建并发布 Python 包

 

如果你的包有一个单独的文档网站,那么还有一个 documentation 属性。

keywords

这些出现在 PyPI 页面的 Meta 部分:

用 Poetry 创建并发布 Python 包

 

classifiers

“Trove分类器”作为 PyPI 包的类别,可以用来过滤 PyPI 上的包。它们出现在 PyPI 页面的“分类器”部分:

用 Poetry 创建并发布 Python 包

 

完整列表见 PyPI 分类器页面。

[tool.poetry.dependencies]

“依赖项”部分展示了Poetry的一个最佳特征。

当使用普通的 pip 或 Pipenv管理包时,通常在两个位置指定包:dev和部署依赖项的requirements.txt或Pipfile,以及运行时/安装依赖项的setup.py。

Poetry对所有依赖项使用pyproject.toml,这简化了依赖项管理。

这部分包括两个更改:

  1. 将最低的 Python 版本从3.7更新到3.6,以获得更广泛的兼容性
  2. 添加flake8作为依赖项

[tool.poetry.scripts]

Scripts 是“安装包时将被安装的脚本或可执行文件”。换句话说,开发人员可以在这里根据函数创建CLI命令。

脚本的形式为:

用 Poetry 创建并发布 Python 包

 

Flake8 markdown — 包含你的惊喜 — 有一个名为flake8 markdown的CLI命令:

用 Poetry 创建并发布 Python 包

 

在安装 flake8-markdown 包之后, 运行 flake8-markdown 将从 flake8_markdown/__init__.py调用 main() 函数。

信息 要使包成为一个可运行模块,比如python -m flake8-markdown,它需要一个 __main__.py模块。在Flake8 Markdown中, __main__.py 文件导入并运行与上述脚本相同的 main() 函数。

发布包

TestPyPI

TestPyPI 是“一个独立的Python包索引实例,它允许您在不影响实际索引的情况下尝试分发工具和进程”。将包上传到TestPyPI 并从那里安装,可以帮助包维护人员避免发送损坏的包版本。

让我们看看如何将包上载到TestPyPI。

注在将包上载到测试包索引之前,您需要注册一个TestPyPI 帐户。

首先,构建包:

用 Poetry 创建并发布 Python 包

 

接下来,将测试PyPI添加为备用包存储库:

用 Poetry 创建并发布 Python 包

 

现在,把包发布到TestPyPI:

用 Poetry 创建并发布 Python 包

 

最后,通过在 testpypi.pypi.org 上查看包并在独立的虚拟环境中安装测试版本,验证包的外观和工作是否符合预期:

用 Poetry 创建并发布 Python 包

 

PyPI

如果这个包在测试PyPI上看起来很好,并且正常启动,那么发布到PyPI就非常简单:

用 Poetry 创建并发布 Python 包

 

注在将包上传到包索引之前,你需要注册一个PyPI帐户 。此帐户与TestPyPI上的任何帐户都是独立的。

总结

PEP 517 打开了Poetry等工具的大门,提供了一种对开发人员友好的构建 Python 包的方式。因此,用Poetry创建和发布一个包是一种直接的、无需费力的体验。构建一个包就像编写代码和向pyproject.toml文件中添加各部分一样简单。

很愉快,我决定写一首关于它的诗:

浮动Python代码 用Poetry集结 云端之旅

Poetry 诗歌。怎么样?

英文原文:https://johnfraney.ca/posts/2019/05/28/create-publish-python-package-poetry/

译者:青书
 



Tags:Python   点击:()  评论:()
声明:本站部分内容来自互联网,如有任何版权侵犯或其他问题请与我们联系,我们将立即删除或处理。
▌相关评论
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表
▌相关推荐
1、MySQLdbMySQLdb又叫MySQL-python ,是 Python 连接 MySQL 最流行的一个驱动,很多框架都也是基于此库进行开发,遗憾的是它只支持 Python2.x,而且安装的时候有很多前置条件,因为...【详细内容】
2019-06-14 Python  点击:(1)  评论:(0)  加入收藏
回顾在Python进阶记录之基础篇(十六)中,我们介绍了Python面向对象中对属性的访问限制,需要重点掌握私有变量和公有变量的区别和用法,牢记面向对象的编程规则。今天我们讲一下Pyth...【详细内容】
2019-06-14 Python  点击:(1)  评论:(0)  加入收藏
如果您曾经使用setup.py脚本发布过一个python包,那么您可能会发现编写脚本来发布包比编写包本身要困难。Python 开发人员认识到了这一点,并且有一些工具采用了一种更现代的方...【详细内容】
2019-06-14 Python  点击:(1)  评论:(0)  加入收藏
今天呢,给大家带来一个Python的暴力破解加密的压缩文件的方法~(是不是压缩文件不重要)。另外你会不会Python也不重要 首先,我们得说一下,如何打开一个压缩文件,如下: 打开一个...【详细内容】
2019-06-14 密码  点击:(1)  评论:(0)  加入收藏
文 | piglei@piglei 公众号编辑 | EarlGrey编程派公众号授权发布“容器”这两个字很少被 Python 技术文章提起。一看到“容器”,大家想到的多是那头蓝色小鲸鱼:Docker,但这篇文...【详细内容】
2019-06-06 Python  点击:(2)  评论:(0)  加入收藏
关于cookie和session估计很多程序员面试的时候都会被问到,这两个概念在写web以及爬虫中都会涉及,并且两者可能很多人直接回答也不好说的特别清楚,所以整理这样一篇文章,也帮助自...【详细内容】
2019-06-06 Python  点击:(6)  评论:(0)  加入收藏
回顾在Python进阶记录之基础篇(十一)中,我们介绍了Python中迭代器与生成器的相关知识点,需要重点掌握迭代器与生成器的概念与基本用法。今天我们来讲一下Python中的几个高阶函数...【详细内容】
2019-06-06 Python  点击:(3)  评论:(0)  加入收藏
本套教程学习时间15天1-3天内容:为Linux基础命令4-13天内容:为Python基础教程14-15 天内容:为飞机大战项目演练第一阶段(1-3天):该阶段首先通过介绍不同领域的三种操作系统,操作系...【详细内容】
2019-06-05 Python,教程  点击:(10)  评论:(0)  加入收藏
导读:在本文中,你会学到如何处理数字、定义与使用变量和常量,以及编写使用这些数据类型执行实际任务的简单程序。作者:凯·霍斯特曼(Cay Horstmann),兰斯·尼塞斯(Rance...【详细内容】
2019-06-05 Python  点击:(10)  评论:(0)  加入收藏
目录 Python中的基本main()函数 Python中的执行模式 基于命令行执行 导入模块或解释器 Main函数的最佳实践 将大部分代码放入函数或类中 使用__name__控制代码的执行 创建名...【详细内容】
2019-06-05 Python  点击:(13)  评论:(0)  加入收藏
作者 | Jeff Hale译者 | 风车云马;责编 | Jane,Rachel出品 | Python大本营(ID:pythonnews)【导读】在编写一些Python程序的时候,我们常常需要与文件系统进行交互。在本文中,营长...【详细内容】
2019-06-05 Python  点击:(6)  评论:(0)  加入收藏
导读:数据分析将作为一门通用技能,进入越来越多的不同工作中。毕竟“技多不压身”,掌握数据分析,一方面可以提升自己相应的业务能力,另一方面也可以让自己建立一种从数据出发的视...【详细内容】
2019-05-17 Python  点击:(13)  评论:(0)  加入收藏
在我们覆盖 7 个 PyPI 库的系列文章中了解解决 Python 问题的更多信息。-- Moshe Zadka(作者)Python 是当今使用最多的 流行编程语言 之一,因为:它是开源的,它有广泛的用途(例如...【详细内容】
2019-05-17 Python  点击:(9)  评论:(0)  加入收藏
Python是一种计算机程序设计语言,它是一种动态的、面向对象的脚本语言。它是一种跨平台的,可以运行在 Windows,Mac和 Linux/Unix系统上。在日常使用中需要对大量数据进行数据分...【详细内容】
2019-05-16 Python,数据库  点击:(15)  评论:(0)  加入收藏
有着20年编程经验的资深程序员,以自己多年来的经历,总结出程序员的编程语言切换规律,做了一个主流编程语言的进阶流程图,展示不同编程语言之间的承接关系、程序员选择编程语言...【详细内容】
2019-05-16 编程  点击:(11)  评论:(0)  加入收藏
CDA数据分析研究院出品介绍你是否曾经处理过具有一千多个特征的数据集?5万多个特征呢?我曾经有过,让我告诉你这是一项非常具有挑战性的任务,特别是如果你不知道从哪里开始的时候...【详细内容】
2019-05-15 Python  点击:(22)  评论:(0)  加入收藏
要完全理解透生成器,需要我们先掌握三个概念: 可迭代对象(Iterable) 迭代器(Iterator) 迭代(Iteration)放一张图来理解,来自这里 额外提到了容器(container),说的是我们的集合类...【详细内容】
2019-05-15 Python  点击:(10)  评论:(0)  加入收藏
进程和线程什么是进程?进程就是正在运行的程序, 一个任务就是一个进程, 进程的主要工作是管理资源, 而不是实现功能什么是线程?线程的主要工作是去实现功能, 比如执行计算....【详细内容】
2019-05-14 python  点击:(11)  评论:(0)  加入收藏
一、选取节点常用的路劲表达式:<img src="https://pic4.zhimg.com/v2-0ea5d1dba9a1cf0c04695edbcfbc248b_b.jpg" data-caption="" data-size="normal" data-rawwidth="681"...【详细内容】
2019-05-09 Python,Xpath  点击:(14)  评论:(0)  加入收藏
加密你的数据并使其免受攻击者的攻击。-- Moshe Zadka(作者)密码学俱乐部的第一条规则是:永远不要自己发明密码系统。密码学俱乐部的第二条规则是:永远不要自己实现密码系统:在现...【详细内容】
2019-05-09 Python  点击:(11)  评论:(0)  加入收藏
推荐资讯
相关文章
栏目更新
栏目热门
'); })();