为什么打包源码
如果你想让你的实现的python代码,通过pip install 方式供所有人进行下载;那就需要将代码上传到PyPi上,这样才能让所有人使用。
一、前提条件
- 有一个pypi官网账号
- 更新pip版本到最新:py -m pip install --upgrade pip
- 通过pip安装twine:要使用twine来上传代码;
- 安装编译工具:pip install --upgrade build
二、调整项目结构
1、本地目录结构
daletou/
└── src/
└── daletou/
├── __init__.py
└── dlt.py
#以上除了src和__init__.py为固定值,其他都可以自定义。
#其中__init__.py是为了将目录作为包导入,默认可以为空。
#dlt.py是包中的一个模块,主要是提供便于下载人调用的功能。
2、最终文件结构
daletou/
├── LICENSE
├── pyproject.toml
├── README.md
├── setup.py
├── src/
│ └── daletou/
│ ├── __init__.py
│ └── dlt.py
#pyproject.toml告诉构建工具构建项目所需的内容。
#README.md 是包的描述信息,markdown格式书写
#setup.py是setuptools的构建脚本。它告诉 setuptools 您的包(例如名称和版本)以及要包含的代码文件。
#LICENSE是许可文件
三、编译打包上传
- 在pyproject.toml文件同级目录,打开命令行工具;
- 执行命令进行编译打包:python -m build
- 打包完成后,会生成dist文件和打包文件;
- 执行命令检查是否存在问题,有问题提示,需要解决:twine check dist/*
- 执行命令上传源码:twine upload dist/*
- 验证是否可以安装:访问上传成功的地址,是否存在你上传的包;使用pip install *** 验证是否可以安装;
注意:如果使用的镜像不是官网,例如国内使用最多的清华镜像,可能需要等5分钟以上才能安装,镜像同步需要时间;