本文档主要用于生成自己的第三方包,还没有涉及上传步骤。
依赖包安装
保证安装wheel、setuptools 、twine三个包
- wheel,用于打包
- setuptools,用于打包
- twine,用于上传pypi
创建目录结构
/packaging_tutorial
/example_pkg
init.py
setup.py
LICENSE
README.md
配置setup.py内容
import setuptools
with open("README.md", "r") as fh:
long_description = fh.read()
setuptools.setup(
name="example-pkg-your-username", #包名
version="0.0.1", #版本号
author="Example Author", #作者
author_email="author@example.com", #email
description="A small example package", #简述
long_description=long_description, #包功能详述
long_description_content_type="text/markdown", #说明文档格式
url="https://github.com/pypa/sampleproject", #该项目的源码
packages=setuptools.find_packages(),
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
)
编写README.md
编写创建许可证
许可证选择地址:https://choosealicense.com/
Copyright (c) 2018 The Python Packaging Authority
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
程序打包
在setup.py同级下执行命令
python3 setup.py sdist bdist_wheel
将生成文件
dist/
example_pkg_your_username-0.0.1-py3-none-any.whl
example_pkg_your_username-0.0.1.tar.gz
参考网页:https://packaging.python.org/tutorials/packaging-projects/