Rubra 项目使用教程

Rubra 项目使用教程

rubra AI Assistants made easy 项目地址: https://gitcode.com/gh_mirrors/ru/rubra

1. 项目目录结构及介绍

Rubra 项目的目录结构如下：

rubra/
├── demo/
│   └── email_assistant/
├── docs/
├── github/
│   └── workflows/
├── rubra-tools/
├── tools/
│   └── cpp/
├── vllm/
├── .gitignore
├── .gitmodules
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── README_CN.md
├── pyproject.toml
└── pre-commit-config.yaml

目录结构介绍

• demo/: 包含项目的演示代码，例如 email_assistant 目录。
• docs/: 包含项目的文档文件。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• rubra-tools/: 包含 Rubra 工具的相关代码。
• tools/cpp/: 包含 C++ 工具的相关代码。
• vllm/: 包含 vLLM 工具的相关代码。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• Makefile: 项目的 Makefile 文件。
• README.md: 项目的英文介绍文件。
• README_CN.md: 项目的中文介绍文件。
• pyproject.toml: Python 项目配置文件。
• pre-commit-config.yaml: 预提交钩子配置文件。

2. 项目启动文件介绍

Rubra 项目的启动文件主要依赖于 Makefile 和 pyproject.toml 文件。以下是启动项目的步骤：

使用 Makefile 启动

1. 打开终端并导航到项目根目录。

2. 运行以下命令启动项目：

   make run
   

   Makefile 中定义了 run 目标，该目标会执行项目的启动命令。

使用 pyproject.toml 启动

1. 确保已安装 Poetry（Python 包管理工具）。

2. 运行以下命令启动项目：

   poetry run python -m rubra
   

   pyproject.toml 文件中定义了项目的依赖和启动脚本。

3. 项目配置文件介绍

Rubra 项目的主要配置文件包括 pyproject.toml 和 pre-commit-config.yaml。

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，定义了项目的依赖、构建系统和启动脚本。以下是示例内容：

[tool.poetry]
name = "rubra"
version = "0.1.0"
description = "Open Weight tool-calling LLMs"
authors = ["Your Name <your.email@example.com>"]

[tool.poetry.dependencies]
python = "^3.8"
# 其他依赖项

[tool.poetry.dev-dependencies]
# 开发依赖项

[tool.poetry.scripts]
rubra = "rubra.__main__:main"

pre-commit-config.yaml

pre-commit-config.yaml 是预提交钩子的配置文件，用于在提交代码前自动执行代码检查和格式化。以下是示例内容：

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-added-large-files

通过这些配置文件，可以确保项目的依赖管理、代码质量和提交规范。

rubra AI Assistants made easy 项目地址: https://gitcode.com/gh_mirrors/ru/rubra