在 Mac OS X 上创建 Python 项目

一. 引言

PyFabricate 是一款适用于 Mac OS X 的应用程序，旨在简化 Python 项目的创建过程。

二. 概述

PyFabricate 采用向导式界面来收集项目的详细信息，以便生成所需的项目结构。

三. 假设

在使用 PyFabricate 之前，假设开发者已经使用 HomeBrew 安装了相关的依赖项。以下是一些关键的假设条件：

1. Python 版本管理：通过 pyenv 管理 Python（用于创建虚拟环境）。
2. 可选依赖：安装了 direnv。
3. 项目名称：项目名称与模块包名称相同。

四. 安装

要安装 PyFabricate，请从以下链接获取当前版本：

• 下载链接

将下载的文件复制到 Mac OS 的应用程序文件夹中。该应用程序经过 Apple 代码签名，首次执行时会显示简单的消息，您需要对此进行确认。

五. 项目结构细节

以下是 PyFabricate 创建的初始项目骨架示例。注意，它不会显示创建的虚拟环境。我们会在后续部分详细讨论。

样例 PyFabricate 项目结构

PyFabricate 创建的项目结构主要包括 src 和 tests 目录。在项目根目录中，创建以下文件：

• .envrc // 环境变量配置文件
• .gitignore // Git 忽略文件
• .mypi.ini // MyPI 配置文件
• .python_version // Python 版本文件
• .LICENSE // 许可证文件
• README.md // 项目说明文件
• pyproject.toml // 项目配置文件
• requirements.txt // 依赖包文件

此外，PyFabricate 还会在合适的位置创建所有的 Python 包文件（__init__.py），并最终生成两个日志配置文件，一份用于应用程序，另一份用于单元测试。

在构建完成后，PyFabricate 会创建一个 Python 虚拟环境。由于技术限制，PyFabricate 无法使用 pyenv 版本的 Python 来创建虚拟环境，因此依赖于 Homebrew 安装的 Python 版本。

六. 向导用户界面

PyFabricate 的向导用户界面分为四个步骤，以收集足够的项目详细信息，从而填充骨架模板。模板使用以下自解释的替换标记。

替换标记说明

向导 UI 步骤

步骤一 - 介绍

此步骤是对 PyFabricate 的介绍。在此步骤之后，PyFabricate 会尽力确保执行所需的依赖项得到满足。如果不满足条件，开发者将无法继续下一步。

步骤二 - 项目详情

在此步骤中，PyFabricate 收集项目特定信息。这些信息大多数用于填充 pyproject.toml 模板。

步骤三 - 基础目录

PyFabricate 假设开发者将所有 Python 项目保存在一个子目录中。这是一种偏见视角，仅仅是一种组织偏好。

步骤四 - Python 版本

PyFabricate 查询 pyenv 以获取开发者安装的 Python 版本。这些版本是 PyFabricate 创建 Python 虚拟环境的唯一选择。

七. 操作日志

在向导结束时，PyFabricate 会显示创建项目时的日志。以下是一个示例日志：

# 控制台日志示例
Creating project directory...
Setting up virtual environment...
Installing dependencies...
Project created successfully!

八. 定制化

如前所述，开发者可以定制项目生成的某些方面。PyFabricate 将其使用的模板存储在 $HOME/.config/pyfabricate/templates 中。

模板位置示例

例如，开发者可能希望使用不同的许可证，只需替换 LICENSE.template 文件即可。

九. 总结

目前，PyFabricate 的版本仅为 0.5.0。我正在探索添加其他功能和去除现有限制。通过使用 PyFabricate，开发者可以更轻松地创建结构合理的 Python 项目，加速开发流程，提升工作效率。