zyt-auto-tools 0.5.0

A collection of automation tools for Python projects

zyt_auto_tools

zyt_auto_tools 是一个 Python 工具集，旨在帮助开发者自动化常见的项目任务。它包含以下工具：

1. 自动生成 __init__.py 文件：根据指定目录下的指定部分文件，自动生成 __init__.py 文件。
2. 自动创建 Python 文件：快速生成带有标准模板的 Python 文件。
3. 自动更新文件修改时间：更新项目中今天修改过的 .py 文件的 Update 日期。
4. 自动生成项目结构图：生成项目的目录结构图，支持文本和 .gitignore 规则。
5. 自动比较项目结构图：快速比较一个或多个项目目录结构图，输出差异结构图。
6. 自动创建 Python 项目文件夹：快速生成指定类型的 Python 项目架构文件夹。

📌 当前版本：v0.5.0 ｜ 🆕 查看更新日志 »

---

安装

你可以通过 pip 安装这个工具集：

pip install zyt-auto-tools

---

使用方法

1. 自动生成 __init__.py 文件

在项目根目录下运行以下命令，自动生成指定目录下的 __init__.py 文件（默认utils下全部文件）：

auto-generate-init

① 你还可以通过 '-d' 或 '--dir' 指定目标目录（默认utils）：

auto-generate-init --dir ./my_project

② 你还可以通过 '-i' 或 '--include' 指定所包含的文件名（默认选择包含以.py结尾的文件）：

# 例如选择文件名中含有xxx的文件
auto-generate-init --include *xxx*

③ 你还可以通过 '-t' 或 '--type' 来选择生成的内容（public:非_开头的顶层类和函数;all:全部顶层类和函数;star:通配导入,默认public）：

auto-generate-init --type public

or

auto-generate-init --type all

or

auto-generate-init --type star

④ 你还可以通过 '-a' 或 '--author' 指定作者：

auto-generate-init --author your_name

作者名可以通过环境变量 DEFAULT_AUTHOR 设置：

# Linux
export DEFAULT_AUTHOR=your_name

or

# Windows
$env:DEFAULT_AUTHOR = "your_name"

2. 自动创建 Python 文件

使用以下命令快速创建一个带有标准模板的 Python 文件（默认在项目根目录下，默认本作者）：

auto-init-python-file my_script.py

① 你还可以通过 '-d' 或 '--dir' 指定目标目录：

auto-init-python-file my_script.py --dir ./my_project

② 你还可以通过 '-a' 或 '--author' 指定作者：

auto-init-python-file my_script.py --author your_name

作者名可以通过环境变量 DEFAULT_AUTHOR 设置：

# Linux
export DEFAULT_AUTHOR=your_name

or

# Windows
$env:DEFAULT_AUTHOR = "your_name"

3. 自动更新文件修改时间

在项目根目录下运行以下命令，更新全部根目录下今天修改过的 .py 文件的 Update 日期：

auto-update-ctime

① 你还可以通过 '-d' 或 '--dir' 指定目标目录：

auto-update-ctime --dir ./my_project

4. 自动生成项目结构图

在项目根目录下运行以下命令，生成项目的目录结构图（默认输出到控制台）：

auto-create-structure

① 你还可以通过 '-d' 或 '--dir' 指定目标目录：

auto-create-structure --dir ./my_project

② 你还可以通过 -o 或 --output 指定输出文件路径：

auto-create-structure --output project_structure.txt

③ 你还可以通过 -i 或 --ignore 指定额外忽略的目录/文件（支持通配符）：

auto-create-structure --ignore *.log tests/

④ 你还可以通过 --use-gitignore 使用 .gitignore 文件中的规则替换默认忽略列表：

auto-create-structure --use-gitignore

⑤ 你还可以通过 --only-dirs 指定只输出到文件夹层级：

auto-create-structure --only-dirs

5. 自动比较项目结构图

在项目根目录下运行以下命令，比较一个或多个项目目录结构图文本文件，输出差异结构图。（默认输出到控制台）：

① 你可以通过 '-c' 或 '--compare' 指定待比较文本文件; 通过 '-b' 或 '--base' 指定被比较文本文件：

auto-compare --compare a.txt --base b.txt

② 支持多个待比较文件分别与多个被比较文件一起进行比较：

auto-compare --compare a1.txt a2.txt --base b1.txt b2.txt b3.txt

③ 你还可以通过 -o 或 --output 指定输出文件路径：

auto-compare -c a.txt -b b.txt --output compare_structure.txt

6. 自动创建 Python 项目文件夹

使用以下命令快速创建指定类型的 Python 项目文件夹（默认在项目根目录下，默认本作者, 默认类型为标准的python文件夹）：

auto-init-python-dir

① 你还可以通过 '-t' 或 '--type' 指定项目类型(支持None, software, crawler, spiders)：

auto-init-python-dir --type software

② 你还可以通过 '-d' 或 '--dir' 指定目标目录：

auto-init-python-dir --dir ./my_project

③ 你还可以通过 '-a' 或 '--author' 指定作者：

auto-init-python-dir --author your_name

作者名可以通过环境变量 DEFAULT_AUTHOR 设置：

# Linux
export DEFAULT_AUTHOR=your_name

or

# Windows
$env:DEFAULT_AUTHOR = "your_name"

---

更新日志

V0.5.0

2025-08-12

✨ 新增功能

1. auto-compare 命令
可快速比较两个或多个树状文本文件的差异

• ① 可指定待比较的树状文本文件：
  • 单个文本文件
  • 多个文本文件分别待比较
• ② 可指定被比较的树状文本文件：
  • 单个文本文件
  • 多个文本文件一起被比较
• ③ 可指定图像输出路径：
  • 只显示在命令行中（默认值）
  • 输出并保存到指定文件路径

⚙️ 功能优化

1. auto-create-structure 命令

• ① 新增only-dirs参数，可选择生成的结构图只到文件夹层级

📜 完整更新日志

点此查看所有历史版本和详细改动说明：
🔗查看完整更新日志 »

---

贡献

欢迎贡献代码！

许可证

本项目基于 MIT 许可证 开源。

作者

• ZhangYuetao - 项目开发者
• 邮箱: [e-mail]