packaged

打包 Python 应用程序的最简单方法。

网站上提供的演示应用：packaged.live

packaged 可以将任何 Python 项目打包成一个独立的可执行文件，该文件可以在没有安装 Python 的其他机器上运行。

安装

pip install packaged

使用方法

packaged <输出路径> <构建命令> <启动命令> [<源目录>] [--python-version=3.12]

例如：

packaged my_project.sh 'pip install .' 'python -m your_package' path/to/project

默认情况下，这将把 Python 3.12 与你的应用程序一起打包。

要指定不同的 Python 版本，请使用 --python-version 标志，如下所示：

packaged my_project.sh 'pip install .' 'python -m your_package' path/to/project --python-version=3.10

示例

以下所有示例都会创建一个独立的可执行文件。你可以将生成的二进制文件发送到具有相同操作系统和架构的其他机器上，它将以相同的方式运行。

你还可以在发布页面找到预构建的二进制文件。

Mandelbrot（numpy、matplotlib、GUI）

packaged ./mandelbrot.sh 'pip install -r requirements.txt' 'python mandelbrot.py' ./example/mandelbrot --python-version=3.10

这会生成一个 ./mandelbrot.sh 二进制文件，包含：

• Python 3.10
• matplotlib
• numba
• llvmlite
• pillow

它会输出一个交互式的 Mandelbrot 集 GUI。

扫雷（使用 packaged.toml 进行配置）

你可以使用 packaged.toml 文件，然后只需执行 packaged path/to/project 来创建你的包。例如，尝试 minesweeper 项目：

packaged ./example/minesweeper

这个配置用于构建包。不使用 pyproject.toml 构建项目的等效命令是：

packaged minesweeper.sh 'pip install .' 'python -m minesweeper' ./example/minesweeper

Posting（基于 TUI 的 API 测试应用）

Posting 是一个完全在终端中运行的 Postman 替代品。这是制作可执行文件的完美候选！

由于依赖项本身包含所有需要的源代码，你可以跳过最后一个参数。这样，除了构建步骤中生成的内容外，不会打包其他文件。

packaged ./posting.sh 'pip install posting' 'posting'

这将简单地将 posting 应用程序打包成一个单独的文件。

Aliens（pygame）

Pygame 也附带了各种游戏，pygame.examples.aliens 就是其中之一：

packaged ./aliens 'pip install pygame' 'python -m pygame.examples.aliens'

你还可以尝试 pygame.examples.chimp。

IPython（控制台脚本）

暴露 shell 脚本的包（如 ipython）在创建包时也应该正常工作，这些脚本可以用作启动命令：

packaged ./ipython 'pip install ipython' 'ipython'

现在运行 ./ipython 就可以启动一个便携版的 IPython！

本地开发/测试

要在本地测试和修改包：

• 创建并激活虚拟环境
• 运行 pip install -r requirements-dev.txt 进行可编辑安装
• 运行 pytest 执行测试
• 根据需要进行修改

类型检查

运行 mypy .

创建并上传包到 PyPI

确保在 setup.cfg 中更新版本号。

然后运行以下命令：

rm -rf build dist
python setup.py sdist bdist_wheel

然后使用 twine 上传到 PyPI：

twine upload dist/*

许可证

该包根据 GNU 通用公共许可证第 2 版（GPLv2）授权。但请注意，使用 packaged 创建的包不受 GPL 许可。这是因为创建的归档文件只是包的数据，packaged 不是创建的归档文件的一部分。

这意味着你可以自由地将 packaged 用于商业用途。

有关更多信息，请阅读 Makeself 的许可证部分。