Python 项目代码写完了,然后怎么打包和发布?
学习python的正确姿势
共 1749字,需浏览 4分钟
· 2020-07-24
你把你的代码写完了,是不是要给别人使用下,怎么打包你的项目代码呢?
喂,开源么?
接下来小帅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!
扫一扫
学习 Python 没烦恼
评论
金融研究 | 使用Python测量关键审计事项的「信息含量」
Tips: 公众号推送后内容只能更改一次,且只能改20字符。如果内容出问题,或者想更新内容, 只能重复推送。为了更好的阅读体验,建议阅读本文博客版, 链接地址https://textdata.cn/blog/2023-01-13-information-content-of-critical-aud
大邓和他的Python
0
金融研究(更新) | 使用Python构建关键审计事项的「信息含量」
Tips: 公众号推送后内容只能更改一次,且只能改20字符。如果内容出问题,或者想更新内容, 只能重复推送。为了更好的阅读体验,建议阅读本文博客版, 链接地址https://textdata.cn/blog/2023-01-13-information-content-of-critical-aud
大邓和他的Python
0
老爸嘲讽我了,写破代码一年就挣十几万,他在工地带50个工人,一个月光人头费就3万,让我滚回去跟他干!
点击上方 "大数据肌肉猿"关注, 星标一起成长点击下方链接,进入高质量学习交流群今日更新| 1052个转型案例分享-大数据交流群来自:网络,侵删有个网友的父亲是做工程的,天天就嘲笑他,说他天天写着破代码有啥用,一年就拿个十多万的死工资,然后告诉他自己在工地里面带了50个工人,一个月能抽三万
程序源代码
0
人工智能周刊#18:微软发布手机端大模型、Llama 3 中文模型列表、苹果开源新项目、
主打尊重隐私的搜索引擎 duckduckgo,也推出了 ai chat 服务,可以使用 chatgpt 或者 claude机器学习周刊:关注 Python、机器学习、深度学习、大模型等硬核技术本期目录:1、Qwen1.5-110B:Qwen1.5 系列的首个千亿参数开源模型2、苹果开源
机器学习算法与Python实战
0
谷歌员工爆料 Python 基础团队原地解散
转自 | 机器之心编辑 | 蛋酱什么?谷歌解雇了整个 Python 基础团队?「当与你直接共事的每个人,包括你的主管,都被裁员 —— 哦,是职位被削减,而你被要求安排他们的替代者入职,这些人被告知在不同的国家担任同样的职位,但他们并不为此感到高兴,这是很艰难的一天。」发布这一动态的 Tho
机器学习算法与Python实战
0
谷歌员工爆料Python基础团队原地解散
机器之心报道编辑:蛋酱什么?谷歌解雇了整个 Python 基础团队?「当与你直接共事的每个人,包括你的主管,都被裁员 —— 哦,是职位被削减,而你被要求安排他们的替代者入职,这些人被告知在不同的国家担任同样的职位,但他们并不为此感到高兴,这是很艰难的一天。」发布这一动态的 Thomas Wouter
机器学习初学者
0
15种时间序列预测方法总结(包含多种方法代码实现)
向AI转型的程序员都关注了这个号👇👇👇在这篇文章中,我们将深入探讨时间序列预测的基本概念和方法。我们将首先介绍单元预测和多元预测的概念,然后详细介绍各种深度学习和传统机器学习方法如何应用于时间序列预测,包括循环神经网络(RNN)、一维卷积神经网络(1D-CNN)、Transformer、自回归模型(
机器学习AI算法工程
0
Python加速运行技巧
Python 是一种脚本语言,相比 C/C++ 这样的编译语言,在效率和性能方面存在一些不足。但是,有很多时候,Python 的效率并没有想象中的那么夸张。本文对一些 Python 代码加速运行的技巧进行整理。 0. 代码优化原则 本文会介绍不少的 Python 代码加速运行的技巧。在深入代码优化细
机器学习算法与Python实战
0