如何发布自己的Python库？

Python包发布

- - 1、背景概述
  - 2、操作指南

1、背景概述

为什么我们要发布自己的Python库？如果你想让你的Python代码，通过pip install xxx的方式供所有人下载，那就需要将代码上传到PyPi上，这样才能让所有人使用

那么，如何发布一个Python库呢？本文将通过具体实践为你提供一份简明的指南

首先，发布一个Python库需要做以下准备：

注册一个PyPi账号：https://pypi.org/account/register/
更新pip到最新版本：py -m pip install --upgrade pip
安装编译工具：pip install --upgrade build
安装PyPi上传工具：pip install twine

2、操作指南

2.1、创建项目结构

a、创建本地目录结构

mypro/└── src/└── module/├── __init__.py└── core.py

以上除了src和__init__.py固定外其他都可自定义；目录结构需保持一致

其中__init__.py用于将目录作为包导入，默认可为空；core.py是包中的一个模块，用于提供功能供下载者调用

b、 创建上传所需文件

mypro/├── src/│   └── module/│       ├── __init__.py│       └── core.py├── LICENSE├── README.md├── requirements.txt└── setup.py/pyproject.toml

LICENSE：许可文件：

Copyright (c) 2018 The Python Packaging AuthorityPermission 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.

README.md：包的详细描述

requirements.txt：包的依赖库

setup.py/pyproject.toml：Python项目打包的核心配置文件

setup.py的示例如下：

from setuptools import setup, find_packageswith open("README.md", "r", encoding="utf-8") as f:long_description = f.read()# with open('requirements.txt', "r", encoding="utf-8") as f:
#     required = f.read().splitlines()setup(name="cc_package",                               # 包名version="0.0.1",                                 # 版本号author="cc",                                     # 作者author_email="cc@qq.com",                        # 邮箱description="package test",                      # 简短描述long_description=long_description,               # 详细说明long_description_content_type="text/markdown",   # 详细说明使用标记类型# url="https://github.com/",                     # 项目主页packages=find_packages(where="src"),             # 需要打包的部分package_dir={"": "src"},                         # 设置src目录为根目录python_requires=">=3.6",                         # 项目支持的Python版本# install_requires=required,                     # 项目必须的依赖include_package_data=False                       # 是否包含非Python文件（如资源文件）
)