如何给自己的Python项目制作安装包

Packaging Python Projects¶

本教程将指导您如何打包一个简单的Python项目。它将向您展示如何添加必要的文件和结构来创建包，如何构建包以及如何将其上载到Python包索引。

A simple project

本教程使用名为example_pkg的简单项目。如果您不熟悉Python的模块和导入包，请花几分钟时间阅读包含文件包和模块的Python文档。即使您已经有一个要打包的项目，我们仍然建议您按照本示例包使用此示例包，然后尝试使用自己的包。 要在本地创建此项目，请创建以下文件结构：

/packaging_tutorial
  /example_pkg
    __init__.py

创建此结构后，您将需要在顶级文件夹中运行本教程中的所有命令 - 因此请务必使用cd packaging_tutorial。 您还应该编辑example_pkg / __ init__.py并将以下代码放在其中：

name = "example_pkg"

这只是为了让您可以在本教程后面验证它是否正确安装，并且PyPI不会使用它。

Creating the package files

您现在将创建一些文件来打包此项目并准备分发。创建下面列出的新文件 - 您将在以下步骤中向其添加内容。

/packaging_tutorial
  /example_pkg
    __init__.py
  setup.py
  LICENSE
  README.md

Creating setup.py

setup.py是setuptools的构建脚本。它告诉setuptools你的包（例如名称和版本）以及要包含的代码文件。

打开setup.py并输入以下内容。更新程序包名称以包含您的用户名（例如，example-pkg-theacodes），这可确保您拥有唯一的程序包名称，并且您的程序包不会与本教程后其他人上传的程序包冲突。

 

import setuptools

with open("README.md", "r") as fh: long_description = fh.read() setuptools.setup( name="example-pkg-your-username", version="0.0.1", author="Example Author", author_email="