深圳幻海软件技术有限公司 欢迎您!

这操作厉害:怎么样发布你的 Python 代码给别人 “pip install”

2023-02-27

学习Python的朋友应该都知道,当我们需要使用某些功能的时候,都会去安装一些第三方的模块,比如“pipinstallrequests”,感觉都被别人装了,你有没有想过,自己搞一个模块,给别人直接pipinstall到他的电脑里面直接使用呢?是不是突然就很厉害! 我们思考着,如果打包自己的

学习Python的朋友应该都知道,当我们需要使用某些功能的时候,都会去安装一些第三方的模块,比如 “pip install requests”,感觉都被别人装了,你有没有想过,自己搞一个模块,给别人直接 pip install 到他的电脑里面直接使用呢?是不是突然就很厉害! 

我们思考着,如果打包自己的代码呢?然后给别人用,pipi呢?

我们进入主题:

先要打一个 Python 包到 pypi 上,是需要一定的目录结构的,首先我们可以创建一个目录,作为演示,我在这里创建一个包:

mkdir shuaib_package 
  • 1.

接着我们就进入这个包:

cd shuaib_package/ 
  • 1.

接着我们在这个目录下创建一个存放你代码的目录,这里就叫 xiaoshuaib 好了:

mkdir xiaoshuaib 
  • 1.

我们进入这个目录:

cd xiaoshuaib/ 
  • 1.

创建你的代码,这里为了演示,我就创建一个 xiaoshuaib.py 好了 :

touch xiaoshuaib.py 
  • 1.

在这个 py 里面就简单写一个输出的方法好了:

插一句:想要Python资料的可以关注小编,并在后台私信小编:“01”即可领取。

 

在这个 xiaoshuaib 目录下还必须要创建一个 __init__.py 来告诉别人你的模块是啥:

touch __init__.py 
  • 1.

在这个 __init__.py 写下你的 name 和导入你的代码模块: 

ok,此时此刻,你的文件目录是这样的: 

只有这几个文件还是不够的,我们还要再创建几个必要的文件,分别是 setup.py、LICENSE、READEME.md, 至于创建这几个文件有什么鸟用,等会帅b给你细细地道来,废话不要那么多,先创建再说:

cd shuaib_package/ 
touch setup.py 
touch LICENSE 
touch README.md 
  • 1.
  • 2.
  • 3.
  • 4.

那么到现在这个时候,你的文件目录应该是这样的: 

接下啦就跟你说说这几个文件分别有什么鸟用。

1、setup.py

这个文件主要是要告诉 setuptools ,我们的包里面的一些信息,比如名称啊,版本号啊,作者,邮箱等等...

我们来编辑一些这个文件: 

这里面对应的意思应该不用我多说了吧,就是一些你的模块信息,像我这样填入你自己的就好了。

2、README.md

在这里就可以对你的模块进一步各种吹了,刚我们写的 setup 文件里面也引用到了这个文件,主要是怕你吹的太多,所以直接用 markdown 让你吹个够,我们打开这个 README 文件吹一波: 

好吧,我这里作为演示就只吹这么一点点够了...

3、LICENSE

在开源的世界里, LICENSE 是必不可少的,我们可以在这里声明:你要免费用我的代码是吧?可以,但是你得署名一下啊,要让别人知道这是我搞出来的啊,老子不要钱,但不能说这是你自己搞出来的好吧?

LICENSE 有好几种不同的声明,以后有机会帅b再跟你说说,这次就用 MIT 的 LICENSE ,我们编辑一下我们刚刚创建的 LICENSE: 

好了,现在我们所需的文件就弄好了,接下来就可以将我们的东西给生成可分发的文件,在此之前我们要安装并且更新好 setuptools 和 wheel 模块:

python3 -m pip install --user --upgrade setuptools wheel 
  • 1.

安装完成之后,你就可以在你刚刚创建的目录执行以下命令生成啦:

python3 setup.py sdist bdist_wheel 
  • 1.

这时候你就会发现,你的目录下会多了一个 dist 的目录,这正是 pypi 所需要的 

万事具备,就差 tm 的上传了啊,那么你现在就要有一个 pypi 的账号,你可以到以下链接注册一个账号:

https://pypi.org/account/register/

如果说你只想自己试着小打小闹一下,可以到这里注册一个测试版的:

https://test.pypi.org/account/register/ 

不管咋地,反正你迟早会注册好一个账号的对吧?值得注意的是,你要验证下你的邮箱,代表你不是机器人注册的账号: 

那么此时此刻,你所需的文件也有了,账号也有了,这次就真的只差上传一个动作了,我们需要 twine 这个模块来进行上传操作,先安装一下:

python3 -m pip install --user --upgrade twine 
  • 1.

安装好了之后,相信我,一点也不复杂,一个命令就能搞定上传,进入你的目录,然后执行以下命令把你刚刚生成的 dist 上传上去:

twine upload dist/* 
  • 1.

 

这样,我们就将我们的模块上传上去了!!

去官网搜一下 xiaoshuaib 先: 

哈哈哈哈,有了,我们来安装一波吧:

pip install xiaoshuaib 
  • 1.

 

安装成功,来使用一波:

 

哈哈哈,完美使用。

ok,以上就是从 0 到 发布一个 pypi 包的完整流程,希望对你有帮助,记得点“赞”。