执政官

与 STA Archon 控制器通信的库和参与者。

安装

一般来说，您应该能够archon通过执行安装

pip install sdss-archon

要从源代码构建，请使用

git clone git@github.com:sdss/archon
cd archon
pip install .

码头工人

Actor 可以作为 Docker 容器运行；main（指向标签）和标签的新图像latest是通过 GitHub 操作创建的。图像存储在 GitHub 容器注册表中。拉取最新的图像运行

docker pull ghcr.io/sdss/archon:latest

运行容器

docker run --name archon --rm --detach --network host ghcr.io/sdss/archon:latest

这假设 RabbitMQ 在主机的默认端口上运行，并且 Archon 控制器可以通过主机网络访问。

发展

archon使用诗歌进行依赖管理和打包。要使用可编辑安装，建议您在虚拟环境中进行设置poetry和安装，方法是archon

poetry install

Pip 尚不支持使用 PEP-517 进行可编辑安装。这意味着运行pip install -e .将失败，因为poetry不使用setup.py文件。作为一种解决方法，您可以使用该create_setup.py文件生成一个临时setup.py文件。要archon在没有 的情况下以可编辑模式安装poetry，请执行

pip install --pre poetry
python create_setup.py
pip install -e .

请注意，这只会安装生产依赖项，而不是开发依赖项。您需要手动安装它们（请参阅 参考资料pyproject.toml [tool.poetry.dev-dependencies]）。您还需要随时返回更改create_setup.py的依赖项或元数据参数pyproject.toml。

样式和类型检查

该项目使用黑色代码样式，代码和文档字符串的行长为 88 个字符。建议您black在保存时运行。必须使用isort对导入进行排序。GitHub 测试工作流程检查所有 Python 文件以确保它们符合黑色格式。

提供了flake8、isort和black的配置文件并将被大多数编辑器应用。

对于 Visual Studio Code，以下项目文件与项目配置兼容：

{
    "python.formatting.provider": "black",
    "[python]" : {
        "editor.codeActionsOnSave": {
            "source.organizeImports": true
        },
        "editor.formatOnSave": true
    },
    "[markdown]": {
        "editor.wordWrapColumn": 88
    },
    "[restructuredtext]": {
        "editor.wordWrapColumn": 88
    },
    "editor.rulers": [88],
    "editor.wordWrapColumn": 88,
    "python.analysis.typeCheckingMode": "basic"
}

这假定已安装Python和Pylance扩展。

该项目使用类型提示。键入由使用pyright的测试工作流强制执行（实际上，这意味着如果Pylance在基本模式下不产生任何错误，pyright则不应该）。