开源项目 `setup.py` 使用教程

开源项目 setup.py 使用教程

setup.py项目地址:https://gitcode.com/gh_mirrors/set/setup.py

项目介绍

setup.py 是一个用于 Python 项目打包和分发的脚本文件。它定义了项目的元数据、依赖关系以及如何构建和安装项目。本项目由 Kenneth Reitz 维护，旨在提供一个简单而强大的工具，帮助开发者轻松管理 Python 项目的打包和分发。

项目快速启动

安装依赖

首先，确保你已经安装了 setuptools 和 wheel：

pip install setuptools wheel

创建 setup.py 文件

在你的项目根目录下创建一个 setup.py 文件，并添加以下内容：

from setuptools import setup, find_packages

setup(
    name='your_project_name',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # 添加你的项目依赖
    ],
    entry_points={
        'console_scripts': [
            'your_command=your_package.module:main_function',
        ],
    },
)

构建和安装

在项目根目录下运行以下命令来构建和安装你的项目：

python setup.py sdist bdist_wheel
pip install .

应用案例和最佳实践

应用案例

假设你正在开发一个命令行工具 mytool，你可以使用 setup.py 来打包和分发它。以下是一个简单的示例：

from setuptools import setup, find_packages

setup(
    name='mytool',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        'requests',
    ],
    entry_points={
        'console_scripts': [
            'mytool=mytool.main:main',
        ],
    },
)

最佳实践

1. 明确的项目元数据：确保 name、version、author 等信息准确无误。
2. 清晰的依赖管理：使用 install_requires 明确列出项目依赖。
3. 合理的入口点配置：通过 entry_points 配置命令行工具的入口点。

典型生态项目

Flask

Flask 是一个流行的 Python Web 框架，它的打包和分发也使用了 setup.py。以下是 Flask 的 setup.py 文件的一部分：

from setuptools import setup

setup(
    name='Flask',
    version='1.1.2',
    packages=['flask'],
    include_package_data=True,
    install_requires=[
        'Werkzeug>=0.15',
        'Jinja2>=2.10.1',
        'itsdangerous>=0.24',
        'click>=5.1',
    ],
    entry_points={
        'console_scripts': [
            'flask=flask.cli:main',
        ],
    },
)

Requests

Requests 是一个强大的 HTTP 库，它的 setup.py 文件如下：

from setuptools import setup

setup(
    name='requests',
    version='2.25.1',
    packages=['requests'],
    install_requires=[
        'chardet>=3.0.2,<4',
        'idna>=2.5,<3',
        'urllib3>=1.21.1,<1.27',
        'certifi>=2017.4.17',
    ],
)

通过这些示例，你可以看到 setup.py 在实际项目中的应用和重要性。希望本教程能帮助你更好地理解和使用 setup.py。

setup.py项目地址:https://gitcode.com/gh_mirrors/set/setup.py