Python Project Generator

使用 github actions 生成支持持续集成和持续部署的 Python 项目结构。可以创建纯 Python 项目，也可以创建使用 PyO3 的 Rust 模块的 Python 项目。

纯 Python 项目的包含包

对于包管理，可以选择以下之一

• poetry
• setuptools

开发包

• mypy 用于静态类型检查
• pytest 用于测试
• pytest-cov 用于测试覆盖率报告
• ruff 用于代码检查和格式化

包含 Rust 模块的 Python 项目的包含包

• maturin 用于包管理
• mypy 用于静态类型检查
• pytest 用于测试
• pytest-cov 用于测试覆盖率报告
• ruff 用于代码检查和格式化
• PyO3 用于管理 Rust/Python FFI
• justfile 用于运行命令（使用此功能需要安装 just）

安装

使用 cargo 安装

cargo install python-project-generator

在 Arch 上使用 AUR 安装

paru -S python-project-generator-bin

在 Debian/Ubuntu 上安装

注意：将版本更改为您要安装的版本。

curl -LO https://github.com/sanders41/python-project-generator/releases/download/v1.0.16/python-project-generator_1.0.16_amd64.deb
sudo dpkg -i python-project-generator_1.0.16_amd64.deb

Python Project Generator 也可以使用每个版本提供的二进制文件安装 此处，或者使用 cargo。

如何使用

创建新项目

从终端运行

python-project create

您将被问一系列问题，这些问题将用于生成您的项目。项目生成器将检查 PyPI 以获取包含软件包的最新版本，并在生成项目时使用这些版本。此功能可以通过在运行生成器时使用 -s 或 --skip-download-latest-packages 来禁用。如果检索最新版本存在问题，或者您决定跳过查找最新版本，则将使用默认版本创建软件包。

python-project create -s

运行生成器后，将创建一个新的目录，其名称与您用于 项目缩写 的名称相同。切换到该目录，然后安装 Python 软件包和 pre-commit 钩子。

纯 Python 项目

使用 Poetry 时安装 Python 依赖项。

poetry install

使用 setuptools 时安装 Python 依赖项。

首先创建一个虚拟环境并激活它。

python -m venv .venv
. .venv/bin/activate

python -m pip install -r requirements-dev.txt

安装 pre-commit 钩子。

pre-commit install

PyO3 项目

首先创建一个虚拟环境并激活它。

python -m venv .venv
. .venv/bin/activate

安装依赖项并构建 Rust 模块。

just install

安装 pre-commit 钩子。

pre-commit install

现在您的项目已准备好使用。

保存自定义默认值

您可以为许多项目选项指定默认值。例如，要保存默认创建者

python-project config creator "Wade Watts"

要查看可以设置为默认值的所有值的完整列表，请运行

python-project config --help

要查看当前保存的默认值

python-project config show

要删除自定义默认值

python-project config reset

贡献

如果您有兴趣贡献，请参阅我们的 贡献指南