Apache Flagon Distill 技术文档

1. 安装指南

在开始安装 Apache Flagon Distill 项目之前，请确保您的系统已安装以下先决条件：

• Python (版本 >= 3.8)
• Poetry (版本 >= 1.0)

您可以通过以下命令检查 Python 版本：

python --version

如果您的系统中未安装 Python，您可以从 Python 官方网站 下载安装。我们推荐使用 Python 版本管理工具如 pyenv，具体设置方法请参考 pyenv 使用指南。

安装 Poetry 的方法有多种，以下是两种推荐的方式：

官方安装程序：

适用于 Linux、macOS、Windows (WSL)

curl -sSL https://install.python-poetry.org | python3 -

Windows (Powershell)

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

pipx：

pipx install poetry

以上两种方法可以最小化与系统 Python（全局）安装的依赖冲突风险。一些用户报告说，在使用常规 pip 方法时，Poetry 使用了错误的 Python 环境，而不是项目的本地虚拟环境。如果您遇到问题，请参考官方 Poetry 文档或 GitHub 以获取更深入的安装说明。

安装步骤如下：

1. 克隆仓库：

   git clone https://github.com/apache/flagon-distill.git
   

2. 进入项目目录：

   cd flagon-distill
   

3. 使用 Poetry 安装项目依赖并创建虚拟环境：

   poetry install
   

   此命令会读取 pyproject.toml 文件并安装所有必需的软件包到专用的虚拟环境中。

4. 激活虚拟环境：

   poetry shell
   

   您现在进入到了项目的虚拟环境，该环境将项目的依赖与系统全局的 Python 包隔离开。

5. 运行测试：

   您现在可以运行测试以确保安装正确无误。例如：

   make test
   

   请记住，每次在项目上工作时都需要激活虚拟环境（步骤4）。

更新依赖

要更新项目依赖，您可以使用以下命令：

poetry update

此命令会更新 pyproject.toml 文件以包含包的最新兼容版本。

卸载

要卸载项目及其依赖项，只需退出虚拟环境（如果已激活）：

exit

这将退出虚拟环境。之后您可以安全地删除项目目录。

通过遵循这些安装步骤，您可以使用 Poetry 轻松地设置和管理 Python 项目。祝您编码愉快！

2. 项目的使用说明

项目使用说明请参考 readthedocs.org 页面。

3. 项目API使用文档

API 使用文档请参考项目维基页面。

4. 项目安装方式

项目安装方式已在上述“安装指南”部分详细说明。