分享 Python 代码基础

Beginner

This tutorial is from open-source community. Access the source code

简介

在某些时候,你可能想要将你的代码分享给其他人,可能只是同事。本节介绍了实现这一点的最基本技术。如需更详细的信息,你需要查阅 Python 打包用户指南

创建一个 setup.py 文件

在你的项目目录的顶级目录 /home/labex/project 中添加一个 setup.py 文件。

## setup.py
import setuptools

setuptools.setup(
    name="porty",
    version="0.0.1",
    author="你的名字",
    author_email="you@example.com",
    description="实用的 Python 代码",
    packages=setuptools.find_packages(),
)

创建 MANIFEST.in

如果你的项目还有其他相关文件,请使用 MANIFEST.in 文件指定它们。例如:

## MANIFEST.in
include *.csv

MANIFEST.in 文件放在与 setup.py 相同的目录中。

创建源发行版

要创建代码的发行版,请使用 setup.py 文件。例如:

$ python setup.py sdist

这将在 dist/ 目录中创建一个 .tar.gz.zip 文件。现在你可以将该文件分发给其他人。

安装你的代码

其他人可以使用 pip 以安装其他包的相同方式来安装你的 Python 代码。他们只需要提供上一步中创建的文件。例如:

$ python -m pip install porty-0.0.1.tar.gz

说明

上述步骤描述了创建一个可提供给他人的 Python 代码包的绝对最基本要点。实际上,根据第三方依赖项、你的应用程序是否包含外部代码(即 C/C++)等情况,它可能会复杂得多。涵盖这些内容超出了本课程的范围。我们只是迈出了微小的第一步。

练习 9.5:创建一个包

使用你为练习 9.3 创建的 porty-app/ 代码,看看你是否能重现这里描述的步骤。具体来说,在顶级目录中添加一个 setup.py 文件和一个 MANIFEST.in 文件。通过运行 python setup.py sdist 创建一个源发行文件。

作为最后一步,看看你是否能将你的包安装到一个 Python 虚拟环境中。

总结

恭喜你!你已经完成了发行版实验。你可以在 LabEx 中练习更多实验来提升你的技能。