### 将自定义Python包上传至PyPI的详细步骤 #### 准备工作 为了将自定义的Python包上传到PyPI，需要完成一系列准备工作。这包括创建项目的结构文件、配置必要的元数据以及生成分发包。 #### 创建项目结构 一个标准的Python包通常具有以下基本结构： ```plaintext your_package/ │ ├── your_package/ # 包的实际代码目录 │ ├── __init__.py # 初始化模块 │ └── other_modules.py # 其他实现逻辑的模块 │ ├── pyproject.toml # 构建系统的配置文件 └── setup.cfg # 配置安装选项和其他元数据 ``` `__init__.py` 文件用于标记该目录是一个Python包[^3]。即使它可能为空，也需要存在以便兼容旧版本的工具链。 #### 编写 `pyproject.toml` `pyproject.toml` 是构建系统的核心配置文件。以下是它的基础模板： ```toml [build-system] requires = ["setuptools", "wheel"] build-backend = "setuptools.build_meta" ``` 这段配置指定了所需的依赖项（如 setuptools 和 wheel），并声明了使用的后端为 setuptools[^2]。 #### 添加元数据到 `setup.cfg` `setup.cfg` 中包含了关于包的关键信息，这些信息会被用来描述你的软件包。下面是一份典型的例子： ```ini [metadata] name = your-package-name ; 替换为你的真实包名 version = 0.1 ; 初始版本号 author = Your Name ; 开发者姓名 author_email = you@example.com; 联系方式 description = A short description of the package. long_description = file: README.md ; 使用README作为长描述 long_description_content_type = text/markdown url = https://github.com/username/repo ; 可选链接指向源码仓库 classifiers = Programming Language :: Python :: 3 License :: OSI Approved :: MIT License ; 许可证类型 Operating System :: OS Independent ; 支持的操作系统 [options] package_dir = = src ; 如果代码存放在src下，则指定路径 packages = find: ; 自动发现所有子包 include_package_data = True ; 是否包含额外的数据文件 python_requires = >=3.7 ; 声明最低支持的Python版本 install_requires = requests>=2.0 ; 显式列出依赖项 ``` 上述设置提供了足够的细节来让其他人理解这个包的功能及其需求环境[^1]。 #### 构建分发档案 一旦所有的准备都已完成，可以执行如下命令来生成可供发布的轮子(wheel)和源码(sdist): 在 Windows 上运行: ```bash py -m build ``` 或者，在 Unix 或 macOS 平台上运行: ```bash python3 -m build ``` 这条指令会读取 `pyproject.toml` 来决定如何构建最终产物，并将其存储于新建立的 dist 目录内。 #### 注册与登录 PyPI 首次向 PyPI 提交之前，需先通过 Twine 工具进行身份验证: ```bash twine check dist/* # 检查是否有任何错误 twine upload --repository testpypi dist/* ``` 这里我们推荐先测试上传到 TestPyPI (https://test.pypi.org/) ，确认无误后再正式提交给官方索引服务。 当准备好实际部署时，只需更改目标地址即可： ```bash twine upload dist/* ``` 此时按照提示输入你在 PyPI 的账户凭证。 #### 验证发布状态 最后一步就是检验是否成功上线。访问 https://pypi.org/project/{your-package-name}/ 查看详情页面是否存在且显示正常。 --- ###