摘要:自己写一个python模块如何让别人通过使用pip install
命令安装?
概括:创建项目;配置文件;注册一个账号;使用两行命令发布模块;完成。
创建自己的项目
项目结构
deeplearntool/ deeplearn/ __init__.py tests __init__.py setup.py
主目录是整个包的根目录,setup.py是部署到pip需要的配置文件,子目录deeplearn是真正的python代码位置。
在__init__.py
中写入代码:
def start(): print("import successful")
然后在setup.py
文件中写入以下配置信息(参数里的内容可以修改,可以添加的参数具体可以参考python官方文档)
import setuptools setuptools.setup(name='deeplearnt', version='0.0.2', description='clinical trial information retriver', url='github项目地址 https://github.com/pergrand/deeplearntool', author='用户名', author_email='邮箱', license='MIT', packages=setuptools.find_packages(), zip_safe=False)
准备发布
第一步
setup.py配置文件中的 author 需要在PyPI官网中注册:登录官网,在右边菜单点击Register,注册一个账号。
将用户名写入setup.py配置文件中
第二步
项目上传github;这一步贴出一个链接吧(测试过可用)
https://blog.csdn.net/longgeaisisi/article/details/78012406
发布python模块
第一步
到项目根目录目录,输入:
python setup.py sdist
这个命令会在根目录创建dist目录,并且会根据配置文件中的信息创建对应版本的压缩文件。
第二步
然后输入命令,上传文件:
python setup.py sdist upload
这个命令会根据配置文件信息,将dist下对应的压缩文件上传。
上传成功后查看 https://pypi.org/project/deeplearnt/#history
pip下载验证
pip install deeplearnt
如果源更换了,使用 pip install -i https://pypi.org/project deeplearnt
注:deeplearnt 是配置文件中name的名字