【2】如何发布一个模块到PyPI分享给全世界?

788 查看

1、你得新建一个模块,其实就是新建一个.py文件。但是等等,我们把这个.py文件放在哪里?额……所以还是先新建一个文件夹吧,我们就用和.py文件一样的名字,结果如下:


新建文件夹和模块文件

2、我们在这个wp_diveintolist.py模块文件中随便写个函数吧,这个函数就是我们以后wp_diveintolist.xxx()时候的xxx。

"""
This is the wp_diveintolist module, and it provide you a function called print_lol which can print the lists that may or may not have nested list.
"""


def print_lol(custom_list):
    """
    :param custom_list:the list you wanna print
    :return:each item per line
    """
    for li in custom_list:
        if isinstance(li, list):
            print_lol(li)
        else:
            print(li)

3、在wp_diveintolist文件夹里新建一个setup.py文件,这个文件用来记录我们这个模块的一些基本信息,比如名字、作者、联系邮箱等等。


新建setup.py文件

然后在setup.py中写相关信息,这个是默认格式,所以你照着格式把自己信息填进去即可。

from distutils.core import setup


setup(
    name='wp_diveintolist',
    version='1.0.0',
    py_modules='wp_diveintolist',
    author='wp',
    author_email='weisubao@126.com',
    url='http://www.34miao.com',
    description='A simple print function for nested list.',
)

4、在终端里进入wp_diveintolist文件夹,然后用python setup.py sdist命令进行构建发布文件,大白话就是把我们的模块整理成PyPI需要的格式,运行这个命令后如果你也碰到和我一样那么多not found,不要慌,一切正常。


构建发布文件

5、其实,构建完文件后,我们就可以上传到PyPI了,但是我劝你还是自己试验一下模块是否运行正常。怎么试验?把模块安装到自己电脑里然后看能不能正常导入使用就ok了。

6、把模块安装到自己电脑里。这里一定要有安装权限,mac用户用sudo来安装。同样的,一连串的not found不影响。


安装模块到自己电脑里

7、试一下是否可用,导入正常,使用也正常,OK了。


测试模块是否可用

8、上传到PyPI。我们在简书发布文章,是要登录后才能发布的,如你所知,上传到PyPI,也需要登录。注册一个PyPI账号,然后登录这个账号,上传我们的模块,这就是我们的大概步骤。

9、注册PyPI,这里友情提示一下不要用163或者126的邮箱,因为经常收不到验证邮件,不验证的话账号是不能用的,建议使用gmail邮箱。

10、有了账号后,你可以登录PyPI网站,有一个上传页面,就是你填写一大堆信息然后上传一个文件包,点击提交的那种。但是……能用两行代码搞定的事情为毛要填一大堆东西呢。

11、我们仍然在终端来操作,我们得先在终端登录PyPI,使用python setup.py register,选择1、使用现成的用户名密码登录,然后按照提示输入用户名和密码,哎……呀……我去……什么叫500错误,500错误是服务器端的错误,那也就是说不是我的错喽,一定是PyPI服务器有问题,一定是他们有问题,我才没问题呢,是他们,是……他……们,那怎么办,怎么办,他们修复服务器不是一时半伙就能修复好了的,而且有可能这个问题已经存在好久了,好几个月了,一直没人修复,那么也就意味着我今天、明天、后天都不能上传了,我天啊,我怎么办啊,我做了那么多工作,就剩最后两步了啊,我……天……啊。这就是楼主当时的内心OS啊。


登录PyPI出错

12、别慌,再试几次,有可能是网速什么的原因,访问国外网站么,你懂得。摔……仍然是同样的错误啊。看来注定今天完不成了么。

13、然后楼主开始各种搜索,在stackoverflow上看到了几个回答,但是貌似不管用啊,而且stackoverflow打开好慢啊,逼得楼主不得不打开fanqiang软件。看了几个答案依然不行啊。

14、怎么办?再试一次?好,最后一次了,不行就只能放弃。啪……啪……啪……成功了。怎么回事?难道是我刚刚打开了fanqiang软件么,是的,真的是这个原因,我去。


登录PyPI成功

15、既然已经登录上了,那么我们就剩下最后一步了——上传,好鸡冻啊。使用python setup.py sdist upload,结果显示OK。注意:如果你也是用的wp_diveintolist模块名,那上传肯定是出错的,因为PyPI不能有同名的模块存在,除非我从PyPI网站上删除这个模块,或者你只能用其他名字。


上传成功

16、成功了,真的成功了……慢着,上传到PyPI了?我们瞅瞅去。真的成功了。


已经在PyPI网站

17、我是不是应该推荐一个fanqiang软件?你问为什么?因为这TM太像一篇软文了啊,但并不是。再见!