Python 项目代码写完了，而后怎么打包和发布？

Python 项目代码写完了，而后怎么打包和发布？

小帅b 学习python的正确姿式

你把你的代码写完了，是否是要给别人使用下，怎么打包你的项目代码呢？

喂，开源么？

接下来小帅b就跟你说说，如何打包你的代码。

就拿咱们上次演示的 todo 为例，写完代码以后，代码的目录是这样的：

在 todo 这个目录里面，文件都放在一块儿了，咱们能够这样简单划分一下：

这里建立了一个 package 目录，将源码文件放进去，而后把模板文件和数据库文件分门别类的安排好。

在 package 中，还建立了一个 init.py 仪式感一下。

为了让别人知道你是认真对待这个项目的，你能够在项目文件中建立一个 tests 目录，在里面测试你的代码：

接着能够建立一个 LICENSE ，用来讲明你的这个项目能够被怎么使用？是否是须要声明来源，是否是能够商用？别人用你的项目去搞事情如何避免被抓去吃牢饭等。

现成的开源协议有好几种，不太了解的能够看看我以前写的这个：那些 GitHub 所声明的开源协议都是什么意思？

接着再建立一个 README 文件，来讲明你这个项目是干什么的，如何使用等描述。

如今你的项目文件目录就有点人模人样了：

接下来要建立一个比较重要的文件了 —— setup.py，这个文件主要用来描述你的项目信息，好让 setuptools 打包工具来帮你打包项目。

在根目录下建立一个 setup.py 文件，按如下的方式来写你的项目信息：

每一个参数都是什么意思呢？我来给你说明一下：

long_description：对项目比较长的描述，咱们能够直接从 你刚刚写的 README 文件读取。

name: 你定义的包名，能够用字母、数字、下划线，须要确保惟一性。

version: 项目的版本号。

author: 你（做者）的名称。

author_email: 你（做者） 的邮箱。

description: 项目的简要描述。

long_description_content_type：长描述内容的使用的标记类型，通常为 markdown 或者 rst。

url: 你这个项目的主页地址，也能够直接连接到你这个项目的Github 地址上面去。

include_package_data: 是否添加 py 之外的文件。

package_data: 须要添加 Python 的额外文件列表。

packages: 直接用 setuptool 找到你项目全部相关的包列表。

classifiers: 附加说明，好比这里写的就是使用于 Python3 版本，使用的是 MIT 协议，独立于 OS。

python_requires: python 版本要求。

那么如今，你的项目目录应该是这样子的：

接下来就能够打包了。

若是你以前没有安装过 setuptools 和 wheel 能够先安装一波：

python3 -m pip install --upgrade setuptools wheel

而后在你的项目根目录下，使用以下命令打包：

python3 setup.py sdist bdist_wheel

这时候你的目录会增长这么些文件：

这样就算打包好了，在 dist 目录中，以 tar.gz 结尾的是你项目的源文件，而以 .whl 结尾的就是构建好了给别人使用的发行版。

那么如何将你打包好的项目发布出来，给别人使用呢？

其实以前有说过了，这里再简单的说一下吧：

先安装一下 twine：

python3 -m pip install twine

接着使用 twine 将你打包好的文件上传到 pypi 上面去:

twine upload dist/*

这时候它会提示你输入 pypi 的帐号密码：

没有怎么办？去注册一个呗，到如下连接注册:
https://pypi.org/account/register/

接着输入你的帐号密码，就能够上传上去了：

这时候别人就能够经过 pip 来安装你的项目了：

像这样：

而后就能够给别人使用你的包了：

你在 pip install 的时候，其实就是下载你上传的 whl 文件而后安装：

若是你不想开源，只想给你朋友使用的话，你也能够直接把 dist 这个目录下的文件发给他，让他自行安装一波就可使用了：

ok，以上就是今天小帅b给你带来的分享，但愿对你有帮助，那么咱们下回见，peace！