### Python `setup` 配置选项及其选择方法 #### 1. **基本配置项** 在创建 Python 包时，`setup.py` 是核心文件之一。通过该文件定义包的元数据以及构建过程中的行为。以下是常见的配置选项： - **name**: 定义包名称，用于区分不同的项目[^4]。 ```python name="testdemo" ``` - **version**: 指定版本号，通常采用语义化版本控制 (Semantic Versioning)[^4]。 ```python version="1.0" ``` - **description 和 long_description**: 提供项目的简短描述和详细说明[^4]。 ```python description="project test" long_description="project test" ``` - **author 和 author_email**: 开发者信息。 ```python author="testdemo" author_email="testdemo@gmail.com" ``` - **license**: 许可证类型，例如 MIT 或 GPL。 ```python license="MIT License" ``` - **url**: 项目主页链接[^4]。 ```python url="http://testdemo.com" ``` #### 2. **依赖管理** 为了确保用户的环境能够正常运行该项目，可以通过 `install_requires` 列表指定所需的第三方库及其最低版本要求[^4]。 ```python install_requires=[ 'redis>=2.10.5', ] ``` 此列表会自动解析并安装这些依赖项，在用户执行 `pip install` 时完成下载与安装操作[^3]。 #### 3. **分类器 (`classifiers`)** `classifiers` 字段允许开发者标记软件的相关属性，如支持的操作系统、编程语言版本等。这有助于 PyPI 上更精确地索引和展示项目[^1]。 ```python classifiers=[ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ] ``` #### 4. **入口点 (`entry_points`)** 如果希望提供命令行接口，则可通过 `entry_points` 参数声明脚本位置及调用函数。 ```python entry_points={ 'console_scripts': [ 'testdemo=testdemo.help:main' ] } ``` 当安装完成后，终端可以直接访问名为 `testdemo` 的命令来启动程序逻辑。 #### 5. **其他重要字段** - **packages**: 使用 `find_packages()` 自动发现所有子模块[^4]。 ```python packages=find_packages() ``` - **include_package_data**: 是否包含额外的数据文件，默认为 False。 ```python include_package_data=True ``` - **platforms**: 支持的目标平台范围。 ```python platforms="any" ``` #### 6. **辅助工具——`setup.cfg`** 除了 `setup.py` 外，还可以利用 `setup.cfg` 来存储部分静态配置信息，减少重复编码工作量的同时提高维护效率[^1]。 --- ### 示例代码 以下是一个完整的 `setup.py` 实现案例： ```python from setuptools import setup, find_packages setup( name="example_project", version="0.1.0", description="An example project demonstrating setup configuration.", long_description=open('README.md').read(), author="Example Author", author_email="example@example.com", url="https://github.com/example/example_project", license="MIT", packages=find_packages(exclude=["tests"]), include_package_data=True, classifiers=[ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", ], install_requires=[ "requests>=2.25.1", "numpy>=1.19.5", ], entry_points={ "console_scripts": ["run_example=example_project.main:cli"] }, ) ``` ---