Whipstaff

项目 | 代码 | 跟踪器 | pypi

Whipstaff 是一个用于从您的本地会话操作一个或多个Liberty Deckplan Host（LDHs）的命令行工具。LDH操作工具包的参考实现。

安装

推荐使用您的包管理器安装Whipstaff。推荐的包名是ldh-operator。例如

sudo apt install ldh-operator # Debian-based

或者

pipx install ldh-operator # Python-based

使用方法

获取帮助和可用命令列表

whipstaff --help

安装（从源代码）

如果您想从源代码运行...

1. 安装Python 3.x和pipenv。（有关教程，请参阅https://docs.pipenv.org/install/。）

2. 获取源代码

    git clone https://source.puri.sm/liberty/tool/operator.git ldh_operator_toolkit
   

3. 使用pipenv安装

    cd ldh_operator_toolkit
    pipenv install --dev -e .
   

使用方法（从源代码）

cd ldh_operator_toolkit
pipenv run whipstaff --help
# using "pipenv run" avoids confusion with a regular installation

构建wheel包（可选上传）

按照以下说明构建Liberty CLI作为Python包

git clone https://source.puri.sm/liberty/tool/operator.git ldh_operator_toolkit
cd ldh_operator_toolkit
pipenv install --dev
pipenv shell
# optionally edit default.yaml
python setup.py sdist bdist_wheel

如果一切按预期进行，您应该会得到以下文件

• dist/ldh_operator-<版本>-py3-none-any.whl
• dist/ldh_operator-<版本>.tar.gz

现在，您可以使用twine将创建的Python包可选上传到PyPI

twine upload dist/*

分享和贡献

Whipstaff（LDH操作工具包）
https://source.puri.sm/liberty/tool/operator
版权所有 2018-2020 Purism SPC
SPDX-License-Identifier: AGPL-3.0-or-later

在AGPL-3.0-or-later下共享。我们遵守未经修改的社区公约1.0，并根据DCO 1.1的签署-by行认证来源。欢迎在相同条款下做出贡献。

有关详细信息，请参阅

• COPYING.AGPL.md，完整许可文本
• CODE_OF_CONDUCT.md，完整行为文本
• CONTRIBUTING.DCO.md，完整来源文本