fabrictestbed-extensions

此存储库包含与FABRIC测试床交互的Python API实现，也称为"FABlib"。

FABlib安装

您可以从PyPI安装FABlib的发布版本

$ pip install fabrictestbed-extensions

如果您需要FABlib的最新开发版本，请从git存储库安装它

$ pip install git+https://github.com/fabric-testbed/fabrictestbed-extensions@main

请注意，使用这两种方法安装FABlib都将安装大量依赖项，因此您可能希望在一个虚拟环境中安装FABlib。您最喜欢的虚拟环境管理工具（venv，virtualenv或virtualenvwrapper）应该可以工作。FABRIC团队倾向于使用virtualenvwrapper。

FABlib使用

安装完成后，您可以在Python项目中使用FABlib

from fabrictestbed_extensions.fablib.fablib import FablibManager as fablib_manager

try:
    fablib = fablib_manager()
    fablib.show_config()
except Exception as e:
    print(f"Exception: {e}")

然而，您第一次接触FABlib可能是在FABRIC项目的JupyterHub实例中。登录后，您将看到许多关于FABlib使用的示例。可以在GitHub上找到笔记本源代码。

从FABlib 1.4开始，API文档可以在此处找到。旧的API文档可以在此处找到。

如果您想从安装在您电脑上的Jupyter与FABRIC交互，请参阅：安装FABRIC Python API。

FABlib贡献

对FABlib的贡献是通过GitHub拉取请求进行的。当您提交拉取请求时，一些测试将会对其运行。

• 代码格式化将通过black进行检查。请确保您的代码使用black进行格式化，并使用其默认设置。
• 将检查CHANGELOG.md以确定更新。
• 将构建软件包。
• 将运行单元测试。

您可以使用pytest在您的环境中运行测试，如下所示：

$ pip install -e .[test]
$ pytest

打包FABlib

FABlib使用flit作为构建后端。要构建源和wheel软件包，请执行以下操作：

$ pip install flit
$ flit build

在将flit用作构建后端的同时，继续使用build作为构建前端也应工作正常。

$ pip install build
$ python -m build

发布FABlib

当是时候发布FABlib的新版本时，请记住：（1）更新顶级__init__.py中的包版本，（2）构建源和wheel软件包，（3）将软件包上传到PyPI。

$ flit publish

继续使用twine发布软件包也是一个选项。

$ twine upload dist/*

有关发布到PyPI的详细信息，请参阅flit关于软件包上传的文档。