可以将自己写的实用的代码封装成包,放到Pypi上,分享出去。
需要:
- 写好的代码
- 在PyPI 和 Test PyPI上面注册
(用户名起的简单好记一点,后续要经常用到)
(这两个都要注册哦~)
PyPI:https://pypi.org/ 需要最终放置软件包的地方
Test PyPI:https://test.pypi.org/ 测试的地方
-下载好twinepip install twine
(下载过程中要求Colorama这个包的版本较高,升级或者卸载这个包都不成功,最后尝试直接在site-package下把这个文件删了,重新下载就可以了)
下载过程中的报错:
ERROR: Cannot uninstall 'colorama'. It is a distutils installed project and thus we cannot accurately determine which files belong to it which would lead to only a partial uninstall.
正式步骤:
以我自己做的一个小程序为例:
-
本地创建一个目录,专门放文件,目录名为模块名(我的模块名为db_operations)
注:模块名必须唯一
-
在二级目录下,放置自己的脚本代码(db_query)
-
创建__init__py。这个文件必须有,可以为空。也可以写入语句,用于后续可以方便导入模块。
eg:
这样就可以了 -
然后,需要创建setup.py文件
可以参照我这个最简单的模板:
from setuptools import setup
setup(name='db_operations',
version='0.1.1',
author='K.lz',
author_email='***@***.com',
description='Simple operation of database',
url='https://github.com/kimkimheel',
packages=['db_operations'],
install_requires=['pymysql','pymssql','cx_Oracle'],
zip_safe=False)
相关参数:
name:模块名
version:版本
author:作者
description:简单描述
packages:导入包的列表(这个还可以用setuptools.find_packages()自动写)
install_requires:安装这个包需要的其它第三方库
其他一些可能用到的参数可以看这里:https://www.cnblogs.com/maociping/p/6633948.html
setup.py文件写好后,可以看一下是否配置成功
在目录下打开cmd命令窗口
输入python setup.py check
如果显示 running check就没问题了
-
这个时候可以在本地安装测试一下,安装方法还是在这个目录下面
pip install -e .
但,这里安装后,后续就不好测试了,我这次这里就没安装 -
其余文件配置:写入license和readme文件
license没有特殊需求可以直接使用MIT许可,模板参照:MIT License
或者有其他的需求可以在这里选许可:https://choosealicense.com/
配置好后应包含如图所示:(readme和license)
-
在setup.py目录下,输入
python setup.py sdist
生成分发存档
成功后,可以在目录下面看到多了几个目录
-
上传至Test PyPI
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
按照要求输入用户名和密码就好了
上传好后,可以测试一下试试,从test pypi上面下载下来
pip install --index-url https://test.pypi.org/simple/ 模块名(注意模块名前面有个空格呀)
测试一下,OK了我们就可以上传至Pypi了 -
上传至pypi
twine upload dist/*
还是按照要求输入用户名和密码即可
pip install dsnd-probability 这次可以直接用文件名下载
(注意:用户名和密码一定要输入正确,不然会报ConnectionError: HTTPSConnectionPool)