python使用pip之setup.py编写

Tue, 04 Feb 2025 13:34:10 +0000

1. 基础结构
#

setup.py 是 Python 打包的核心配置文件，需使用 setuptools 库定义包的元数据和构建规则。

基本模板
#

from setuptools import setup, find_packages

setup(
 name="your-package-name", # 包名（PyPI唯一标识）
 version="0.1.0", # 版本号
 author="Your Name",
 author_email="your@email.com",
 description="Short description",
 long_description=open("README.md").read(), # 长描述（README内容）
 long_description_content_type="text/markdown", # README格式
 url="https://github.com/yourusername/your-package", # 项目地址
 packages=find_packages(), # 自动发现包目录
 install_requires=[], # 依赖库列表
 entry_points={}, # 命令行工具入口
 classifiers=[], # PyPI分类标签
 python_requires=">=3.6", # Python版本要求
)

2. 关键参数详解
#

(1) `name`
#

作用：包在 PyPI 上的唯一标识符。
规则：
- 必须全小写，可用连字符（-），如 my-package。
- 需在 PyPI 上未被占用（上传前检查）。

(2) `version`
#

作用：包的版本号，每次更新必须递增。
格式：推荐语义化版本（如 1.0.0, 0.2.5）。

(3) `packages`
#

自动发现：

packages=find_packages(), # 自动搜索所有含 __init__.py 的目录

手动指定：

packages=["my_package", "my_package.submodule"],

(4) `install_requires`
#

作用：定义包的依赖库及版本约束。

示例：

install_requires=[
 "requests>=2.25.1", # 最低版本
 "numpy<1.22,>=1.20", # 版本范围
 "pandas", # 不限制版本
]

(5) `entry_points`
#

作用：定义命令行工具入口，生成可执行命令。

示例：

entry_points={
 "console_scripts": [
 "my-command=my_package.module:main", # 格式：命令名=包.模块:函数
 ],
}

用户安装后可直接运行 my-command。

(6) `package_data`
#

作用：包含包内的非代码文件（如数据、配置文件）。

示例：

package_data={
 "my_package": ["data/*.csv", "templates/*.html"],
},

(7) `include_package_data`
#

作用：自动包含 MANIFEST.in 中指定的文件。

用法：

include_package_data=True, # 需配合 MANIFEST.in 文件

(8) `classifiers`
#

作用：为 PyPI 提供包的分类标签（便于搜索）。

常用选项：

classifiers=[
 "Programming Language :: Python :: 3",
 "License :: OSI Approved :: MIT License",
 "Operating System :: OS Independent",
 "Topic :: Software Development :: Libraries",
]

完整列表见：PyPI Classifiers

3. 完整示例
#

假设项目结构如下：

Pip on ICE345のBLOG

python使用pip之setup.py编写

1. 基础结构 #

基本模板 #

2. 关键参数详解 #

(1) name #

(2) version #

(3) packages #

(4) install_requires #

(5) entry_points #

(6) package_data #

(7) include_package_data #

(8) classifiers #

3. 完整示例 #

1. 基础结构
#

基本模板
#

2. 关键参数详解
#

(1) `name`
#

(2) `version`
#

(3) `packages`
#

(4) `install_requires`
#

(5) `entry_points`
#

(6) `package_data`
#

(7) `include_package_data`
#

(8) `classifiers`
#

3. 完整示例
#