Python 项目代码写完了,然后怎么打包和发布?

你把你的代码写完了,是不是要给别人使用下,怎么打包你的项目代码呢?喂,开源么?

接下来就跟你说说,如何打包你的代码。
就拿我们上次演示的 todo为例,写完代码之后,代码的目录是这样的:

图片

在 todo 这个目录里面,文件都放在一起了,我们可以这样简单划分一下:

图片

这里创建了一个 package 目录,将源码文件放进去,然后把模板文件和数据库文件分门别类的安排好。在 package 中,还创建了一个 init.py 仪式感一下。为了让别人知道你是认真对待这个项目的,你可以在项目文件中创建一个 tests 目录,在里面测试你的代码:

图片

接着可以创建一个 LICENSE,用来说明你的这个项目可以被怎么使用?是不是需要声明来源,是不是可以商用?别人用你的项目去搞事情如何避免被抓去吃牢饭等。
现成的开源协议有好几种:

图片

接着再创建一个 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 这个目录下的文件发给他,让他自行安装一波就可以使用了:

image.png

作者: 学习python的正确姿势
原文链接:https://mp.weixin.qq.com/s/SyMRQ6KUDTGLB9Px9oBPIg

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容