开发者安装

从源代码构建aeon包是希望为aeon代码库和文档做出贡献的用户的要求。以下指南将引导您从GitHub下载最新的开发源代码并安装该包。

在这些步骤之前，我们强烈建议为安装创建一个虚拟环境。

第一步 - 分叉和/或克隆仓库

第一步是将aeon仓库克隆到本地目录。如果你计划在GitHub仓库上提交拉取请求，你应该首先分叉该仓库。通过点击仓库页面右上角的“Fork”按钮或这里来创建aeon仓库的分叉。

aeon 仓库应使用 Git 克隆到本地目录。

使用git命令行，以下命令将克隆仓库的main分支到本地目录：

git clone https://github.com/aeon-toolkit/aeon.git
cd aeon

如果你已经分叉了仓库，请克隆你的分叉，即：

git clone https://github.com/your-username/aeon.git
cd aeon

步骤 2 - 从源代码构建 aeon

要从源代码构建并安装aeon，请导航到本地克隆的根目录并输入：

pip install --editable .[dev]

注意

If this results in a "no matches found" error, it may be due to how your shell
handles special characters. Try surrounding the dependency portion with quotes i.e.

pip install --editable ."[dev]"

或者，. 可以被替换为根目录的完整或相对路径。

这将以可编辑模式安装aeon包，并包含开发所需的依赖项。--editable标志允许您就地编辑代码，并使更改反映在已安装的包中，而无需重新安装包。

如果您需要使用可选依赖项，您还可以安装all_extras附加项：

pip install --editable .[dev,all_extras]

步骤 3 - 安装 pre-commit

aeon 仓库使用 pre-commit 在提交更改之前对代码库运行一系列检查。要安装 pre-commit，请运行：

pre-commit install

这将在提交更改之前在代码库上运行各种代码质量钩子，可能会更改代码的格式。

这是一个提交拉取请求的要求，只有在特殊情况下，才会接受未通过预提交检查的拉取请求。