如何创建 Python 包并发布

创建和发布 Python 包可让您与更广泛的 Python 社区共享代码。在本指南中，我们将逐步介绍如何创建 Python 包并将其发布到 Python 包索引 (PyPI)，以便其他人可以轻松安装和使用它。

设置你的项目

开始之前，请确保您的系统上已安装 Python。您还需要安装 setuptools 和 wheel 软件包（如果尚未安装）：

pip install setuptools wheel

创建包结构

为您的包项目创建一个新目录。在此目录中，创建以下结构：

your_package/
    your_package/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
    setup.py
    README.md
    LICENSE

以下是这些文件的简要概述：

• your_package/__init__.py：将目录标记为 Python 包。
• your_package/module1.py 和 your_package/module2.py：您的包模块。
• tests/：软件包的测试用例目录。
• setup.py：您的包的构建脚本。
• README.md：一个解释你的包的作用的文件。
• LICENSE：您的软件包的许可证文件。

编写安装脚本

setup.py 文件对于定义包的元数据和依赖项至关重要。这是一个基本示例：

from setuptools import setup, find_packages

setup(
    name='your_package',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # List your package dependencies here
    ],
    description='A brief description of your package',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/your_package',
    author='Your Name',
    author_email='your.email@example.com',
    license='MIT',
)

创建 README 文件

README.md 文件应提供软件包的概述，包括如何安装和使用它。以下是示例：

# Your Package

A brief description of your package.

安装

pip install your_package

用法

import your_package

# Example usage

构建软件包

导航到您的项目目录并运行以下命令来构建您的包：

python setup.py sdist bdist_wheel

此命令在 dist/ 目录中创建分发档案。

发布到 PyPI

要发布您的软件包，您需要一个 PyPI 帐户。如果您没有帐户，请在 PyPI 创建。

接下来，安装 twine 包：

pip install twine

使用 twine 将你的包上传到 PyPI：

twine upload dist/*

系统将提示您输入 PyPI 用户名和密码。上传成功后，您的软件包将在 PyPI 上可用。

结论

恭喜！您现在已经创建并发布了 Python 包。其他人可以使用 pip 安装它，您可以继续更新和改进它。请记住通过更新版本号并在进行更改时上传新版本来维护您的包。