打包与发布你的Python库


Python部落(python.freelycode.com)组织翻译,禁止转载,欢迎转发。

作者:Yasoob 日期:

码农们你们好,这篇帖子将带你们温习打包与发布你的Python库的基础知识。所以不要浪费时间了,咱们开始吧!

文件夹结构

要事第一。你的文件夹结构应该是什么样的?至少你可以有两个文件。第一个文件是setup.py文件,第二个则是你的模块文件。但是今天我不会去讨论最基本的东西。今天我们将采取这样的文件结构。

这里我有4个文件。LICENSE文件包含了你发布模块所包含的许可声明。那我们下一步应该干什么?很明显,该描述我们的模块并且向setup.py里写入一些元数据了。

描述我们的模块

setup.py文件是任何Python模块或库的核心。它描述了模块的内容,并且列出了其他一些有用信息,例如,它列出了模块所依赖的所有依赖库,同时,它也会通知Distutils模块到哪里去寻找这个模块所必须的脚本。所以,让我们尝试利用我们的setup.py文件来描述我们的模块。

打包与发布你的Python库

在这里我们本可以重写long_description,但是我们使用了我们的README文件。我们在version中写了’dev’因为在我们的模块里还没有任何东西,而我们将要发布0.1版本。当你在模块中增加了足够多的代码之后就可以随意去掉’dev’字段了。现在下一个步骤是进行首次发布。

首次发布

所以我们该如何首次发布?很简单,跟着我做。你的发行包应当有一个压缩文件。通过这个命令可以轻松获得:

仅仅需要到你的模块的根目录下执行这个命令。它将创建一个以dist为名的子目录,并且会打包你所有的模块脚本及其他文件到一个压缩文件。这个压缩文件就准备好可以上传到PyPI(Python Package Index)上去了。这个压缩文件在Windows平台将是zip格式文件,而在POSIX系统中,则是tar.gz格式。

发布你的模块

现在压缩文件可以上传到任意地方并进行发布了,不过我们的重点在PyPI上。为了将你的模块上传到PyPI上,你首先需要在http://pypi.python.org/pypi上注册一个账号。在这之后,你将需要像如下这样注册你的包:

在这之后,运行如下命令来将包上传至PyPI。

这样,你的包就会上传到PyPI并发布出去。现在你该对自己非常满意了,因为你刚刚向开源世界发布了你的包。我希望你喜欢我的这篇帖子。如果你想越多关于setup.py的内容请到这里。想要深入学习,我推荐Hichhikers guide to packaging。

英文原文:https://pythontips.com/2013/08/01/packaging-and-distributing-your-python-libraries/
译者:LuCima