新闻资讯  快讯  焦点  财经  政策  社会
互 联 网   电商  金融  数据  计算  技巧
生活百科  科技  职场  健康  法律  汽车
手机百科  知识  软件  修理  测评  微信
软件技术  应用  系统  图像  视频  经验
硬件技术  知识  技术  测评  选购  维修
网络技术  硬件  软件  设置  安全  技术
程序开发  语言  移动  数据  开源  百科
安全防护  资讯  黑客  木马  病毒  移动
站长技术  搜索  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   点击:()  评论:()
声明:本站部分内容来自互联网,内容观点仅代表作者本人,如有任何版权侵犯请与我们联系,我们将立即删除。
▌相关评论
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表
▌相关推荐
B站在小视频功能处提供了 API 接口,今天的任务爬取Bilibili视频~B 站视频网址:https://vc.bilibili.com/p/eden/rank#/?tab=全部 此次爬取视频,我们爬取前100个~我们做好前期...【详细内容】
2019-11-27   Python  点击:(0)  评论:(0)  加入收藏
SQL注入就是攻击者在前端的表单输入中,或者 API 的传参时,按照 SQL 的语法,人为地加入一段代码,改变原有的SQL 逻辑,来跳过验证,篡改或者删除数据库,达到攻击者的目的的过程。SQL注...【详细内容】
2019-11-27   Python  点击:(0)  评论:(0)  加入收藏
通用爬虫和聚焦爬虫根据使用场景,网络爬虫可分为 通用爬虫 和 聚焦爬虫 两种.通用爬虫通用网络爬虫 是 捜索引擎抓取系统(Baidu、Google、Yahoo等)的重要组成部分。主要目的是...【详细内容】
2019-11-27   Python  点击:(0)  评论:(0)  加入收藏
1.1 变量和赋值语句#使用Python变量前必须给它赋值,因为其无默认值x=31.2 Python神奇之处1#可同时给多个变量赋值x,y,z=1,2,3a=b=123#简单的多变量间值交换a,b,c,d='a&#3...【详细内容】
2019-11-25   Python  点击:(1)  评论:(0)  加入收藏
在之前的文章中,我们介绍过编码格式的发展史。今天我们通过几个例子,来彻底搞清楚python3中的编码格式原理,这样你之后写python脚本时碰到编码问题,才能有章可循。 我们先搞清楚...【详细内容】
2019-11-22   Python  点击:(2)  评论:(0)  加入收藏
为什么要学正则表达式实际上爬虫一共就四个主要步骤:明确目标 (要知道你准备在哪个范围或者网站去搜索) 爬 (将所有的网站的内容全部爬下来) 取 (去掉对我们没用处的数据) 处...【详细内容】
2019-11-22   Python  点击:(3)  评论:(0)  加入收藏
无论函数传递的参数的可变还是不可变,只要针对参数使用赋值语句,会在函数内部修改局部变量的引用,不会影响到外部变量的引用,而如果传递的参数是可变类型,在函数内部使用方法修...【详细内容】
2019-11-20   Python  点击:(1)  评论:(0)  加入收藏
要识别两张图片是否相似,首先我们可能会区分这两张图是人物照,还是风景照等......对应的风景照是蓝天还是大海......做一系列的分类。...【详细内容】
2019-11-20   Python  点击:(4)  评论:(0)  加入收藏
今天要给大家介绍的是验证码的爬取和识别,不过只涉及到最简单的图形验证码,也是现在比较常见的一种类型。运行平台:WindowsPython版本:Python3.6IDE: Sublime Text其他:Chrome浏...【详细内容】
2019-11-19   Python  点击:(4)  评论:(0)  加入收藏
我们在做一些数据统计或分析的时候,有时会接触到Execl 格式或者Word 格式的文件。Execl格式的数据提取和解析,我们在之前的文章分享过一些非常好用的Python第三方库,本文中主要...【详细内容】
2019-11-19   Python  点击:(4)  评论:(0)  加入收藏
在实现算法的时候,通常会从两方面考虑算法的复杂度,即时间复杂度和空间复杂度。顾名思义,时间复杂度用于度量算法的计算工作量,空间复杂度用于度量算法占用的内存空间。本文将从...【详细内容】
2019-11-18   Python  点击:(3)  评论:(0)  加入收藏
一直也没写过爬虫的代码,一来是接触练习的少,二来也对爬虫心存偏见:老有种做贼偷数据的感觉。最近在体验过爬虫的高效便捷后,觉得确实有必要多实践一下。其实我本身学爬虫没多久...【详细内容】
2019-11-14   Python  点击:(7)  评论:(0)  加入收藏
GUI,是 Graphics User Interface(图形用户界面)的缩写。在 GUI 中,并不只是输入文本和返回文本,用户可以看到窗口、按钮、文本框等组件,还可以通过鼠标和键盘操作应用。 GUI 是程...【详细内容】
2019-11-13   Python  点击:(5)  评论:(0)  加入收藏
一起学习,一起成长!Numpy数组的索引是一个内容丰富的主题,因为选取数据子集或单个元素的方式有很多。 一维数组In[13]:arr=np.arange(10)In[14]:arrOut[14]: array([0, 1, 2, 3,...【详细内容】
2019-11-13   Python  点击:(4)  评论:(0)  加入收藏
作为数据分析师,我通常会收到诸如“您可以每周向我发送此报告吗?”或“您是否可以每月通过电子邮件向我发送此数据?”这样的请求。发送报告很容易,但是如果您每周必须做同样的事...【详细内容】
2019-11-12   Python  点击:(48)  评论:(0)  加入收藏
1创建web服务器:使用cmd命令进入到存放项目的目录中执行以下命令:python django-admin.py startproject mysite成功后会在目录中出现 mysite 目录,此处创建的为开发服务器2创...【详细内容】
2019-11-12   Python  点击:(7)  评论:(0)  加入收藏
Python 的概念小编使用的centos7下的python版本为2.7,而python要全面转向python3,故升级pyhton迫在眉睫,今天来介绍一下如何升级centos下的python首先要确定需要升级的python...【详细内容】
2019-11-12   Python  点击:(13)  评论:(0)  加入收藏
Python编写类的时候,每个函数参数第一个参数都是self,一开始我不管它到底是干嘛的,只知道必须要写上。后来对Python渐渐熟悉了一点,再回头看self的概念,似乎有点弄明白了。首先...【详细内容】
2019-11-11   Python  点击:(8)  评论:(0)  加入收藏
1. 原理篇我们用人话而不是大段的数学公式来讲讲全连接神经网络是怎么一回事。1.1 网络结构灵魂画师用PPT画个粗糙的网络结构图如下: 1.2 Simoid函数Sigmoid函数的表达式是:...【详细内容】
2019-11-11   Python  点击:(21)  评论:(0)  加入收藏
Colorful Image Colorization图片的颜色上色,主要使用到了CNN卷积神经网络,作者在ImageNet数据集上进行了大量的训练,并将此问题使用在分类任务中,以解决问题的潜在的不确定性,并...【详细内容】
2019-11-11   Python  点击:(7)  评论:(0)  加入收藏
最新更新
栏目热门
栏目头条