PyPI 打包小记

Wed, 18 Oct 2023 00:00:00 +0000

你们这些家伙，好好看看我是怎么打包的吧！

GitHub 项目地址：hit-and-blow

官方教程：Packaging Python Projects
背景知识：Modules

一、文件结构介绍

打包前，需构建如下文件结构：

packaging_tutorial/
├── LICENSE
├── pyproject.toml
├── README.md
├── src/
│   └── YOUR_PACKAGE_NAME/
│       ├── __init__.py
│       └── example.py
└── tests/

各个 文件 / 文件夹 说明：

packaging_tutorial: 项目文件夹
LICENSE: 开源协议，可由 GitHub 生成
pyproject.toml: 打包配置文件
README.md: 项目文档
src: 项目结构要求的，用来放主程序
YOUR_PACKAGE_NAME: 主程序文件夹，以“你的包名”命名文件夹

二、添加配置文件

将以下内容修改一下，改改名字邮箱什么的，存成配置文件 pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "example_package_YOUR_USERNAME_HERE"
version = "0.0.1"
authors = [
  { name="Example Author", email="author@example.com" },
]
description = "A small example package"
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
]

[project.urls]
"Homepage" = "https://github.com/pypa/sampleproject"
"Bug Tracker" = "https://github.com/pypa/sampleproject/issues"

三、打包

3.1 准备打包环境

python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build

3.2 打包

来到 pyproject.toml 所在目录，打开命令行，运行代码：

Package on Chang Luo

PyPI 打包小记

一、文件结构介绍

二、添加配置文件

三、打包

3.1 准备打包环境

3.2 打包