Open Procedures 项目使用文档

Open Procedures 项目使用文档

1. 项目目录结构及介绍

open-procedures/
├── procedures/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── create_procedures_db.py
├── create_vector_db.py
├── main.py
├── poetry.lock
├── procedures_db.json
├── pyproject.toml
├── text_db.json
└── vector_db.json

目录结构说明

• procedures/: 存放项目相关的代码文件或子模块。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 追踪。
• LICENSE: 项目的开源许可证文件，通常为 MIT 许可证。
• README.md: 项目的介绍文件，通常包含项目的概述、安装和使用说明。
• create_procedures_db.py: 用于创建 procedures_db.json 文件的脚本。
• create_vector_db.py: 用于创建 vector_db.json 文件的脚本。
• main.py: 项目的启动文件，包含主要的逻辑代码。
• poetry.lock: Poetry 依赖管理工具的锁定文件，用于确保依赖版本的一致性。
• procedures_db.json: 存储程序相关数据的 JSON 文件。
• pyproject.toml: Poetry 项目的配置文件，包含项目的依赖和构建配置。
• text_db.json: 存储文本数据的 JSON 文件。
• vector_db.json: 存储向量数据的 JSON 文件。

2. 项目启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化项目并运行主要的逻辑代码。以下是 main.py 的基本结构和功能介绍：

# main.py

def main():
    # 初始化项目配置
    initialize_config()
    
    # 加载数据
    load_data()
    
    # 运行主逻辑
    run_main_logic()

def initialize_config():
    # 初始化配置的代码
    pass

def load_data():
    # 加载数据的代码
    pass

def run_main_logic():
    # 运行主逻辑的代码
    pass

if __name__ == "__main__":
    main()

功能说明

• initialize_config(): 初始化项目的配置，可能包括读取配置文件、设置环境变量等。
• load_data(): 加载项目所需的数据，例如从 JSON 文件中读取数据。
• run_main_logic(): 运行项目的主要逻辑，处理用户请求、执行搜索等。

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 Poetry 项目的配置文件，用于管理项目的依赖和构建配置。以下是 pyproject.toml 的基本结构和内容：

[tool.poetry]
name = "open-procedures"
version = "0.1.0"
description = "Tiny, structured coding tutorials that can be searched semantically."
authors = ["KillianLucas <killian@open-procedures.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"
requests = "^2.25.1"

[tool.poetry.dev-dependencies]
pytest = "^6.2.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

配置说明

• [tool.poetry]: 定义项目的基本信息，如名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 定义项目的依赖包及其版本要求。
• [tool.poetry.dev-dependencies]: 定义开发环境的依赖包及其版本要求。
• [build-system]: 定义构建系统的要求和后端。

通过以上配置文件，可以确保项目的依赖管理、构建和发布的一致性和可重复性。