eaio 项目使用教程

1. 项目的目录结构及介绍

eaio/
├── docs/
│   └── README.md
├── eaio/
│   ├── __init__.py
│   ├── main.py
│   └── utils.py
├── .gitignore
├── LICENSE
├── README.md
├── pdm.lock
├── pyoxidizer.bzl
└── pyproject.toml

• docs/: 存放项目文档的目录，包含项目的介绍和使用说明。
• eaio/: 项目的主要代码目录，包含项目的核心功能实现。
  • init.py: Python 包的初始化文件。
  • main.py: 项目的启动文件，包含程序的主入口。
  • utils.py: 包含项目中使用的工具函数。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件，本项目使用 GPL-3.0 许可证。
• README.md: 项目的介绍文件，包含项目的基本信息和使用说明。
• pdm.lock: PDM 包管理工具的锁定文件，记录项目依赖的具体版本。
• pyoxidizer.bzl: PyOxidizer 的配置文件，用于打包 Python 应用程序。
• pyproject.toml: 项目的配置文件，包含项目的依赖和构建配置。

2. 项目的启动文件介绍

main.py

main.py 是 eaio 项目的启动文件，负责初始化项目并启动主程序。以下是 main.py 的主要功能介绍：

import sys
from eaio import core

def main():
    # 初始化项目配置
    config = core.load_config()
    
    # 执行主程序逻辑
    core.run(config)

if __name__ == "__main__":
    main()

• core.load_config(): 加载项目的配置文件，获取项目的运行参数。
• core.run(config): 根据配置文件执行项目的主逻辑，包括文件硬链接、状态检查等操作。

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 eaio 项目的配置文件，使用 PDM 作为包管理工具。以下是 pyproject.toml 的主要内容：

[project]
name = "eaio"
version = "0.2.0"
description = "一个通过将磁盘上所有 Electron 应用中相同文件硬链接到统一位置来减少磁盘占用的解决方案，就像 pnpm 一样。"
authors = [
    { name="WankkoRee", email="[e-mail]" }
]
dependencies = [
    "requests>=2.25.1",
    "click>=7.1.2"
]

[build-system]
requires = ["pdm-pep517"]
build-backend = "pdm.pep517.api"

• [project]: 定义项目的基本信息，包括项目名称、版本、描述和作者。
• dependencies: 列出项目依赖的 Python 包及其版本要求。
• [build-system]: 指定项目的构建系统，使用 PDM 作为构建后端。

通过以上配置，eaio 项目能够正确管理依赖并进行构建和发布。