deriva-client

deriva-client软件包捆绑了一个用于DERIVA平台的Python客户端软件套件。这些工具提供以下功能：

1. 程序性和非基于浏览器的访问的认证服务。
2. 目录资产和（元）数据的批量导入和导出。
3. 目录配置、突变和管理。
4. 用于处理DERIVA使用的文件容器格式bdbags的工具。
5. 用于处理DERIVA使用的轻量级标识符格式minids的工具。

已安装的应用程序

命令行界面（CLI）应用程序

图形用户界面（GUI）应用程序

Windows 和 MacOSX 的安装包

适用于 Windows 和 MacOSX 的 deriva-client 预包装安装包可供下载。这些安装包包含捆绑的 Python 解释器和所有其他软件依赖项，适用于寻求更传统“一站式”安装（无需安装 Python 和管理 Python 软件包安装）的 Windows 和 MacOSX 用户。

在此处下载安装包。

通过 pip 从 PyPi 安装 deriva-client

对于已经安装了 Python 并且熟悉通过 pip 应用程序安装 Python 软件的用户，可以轻松地从 PyPi 使用基本的 pip 命令直接安装 deriva-client 及其所有依赖项。

安装先决条件

• 需要 Python 3.6 或更高版本的系统安装。建议使用最新稳定版本的 Python。
• 请验证是否可以使用 python3 命令从命令行调用适当的 Python 3 解释器。可以通过以下命令简单测试

python3 --version

安装快速入门

以下命令可用于在当前工作目录中执行基于 venv 的 虚拟环境 安装。

Mac/Linux

以下命令假设使用的是 BASH（或兼容）命令行。对于不同的命令解释器（例如 CSH），应在虚拟环境 bin 目录中的适当激活脚本上调用 source 命令。

python3 -m venv ./deriva-client-venv
source ./deriva-client-venv/bin/activate
python3 -m pip install --upgrade pip setuptools wheel
pip install deriva-client

Windows

以下命令假设使用的是 Windows 命令提示符 命令行。对于 Powershell 命令行，应调用 activate.ps1 激活脚本。

python3 -m venv .\deriva-client-venv
.\deriva-client-venv\Scripts\activate
python3 -m pip install --upgrade pip setuptools wheel
pip install deriva-client

重要提示：Python 虚拟环境 与 用户环境

虽然 虚拟环境 安装通常是安装和隔离多个软件包最安全的方式，但在使用之前必须 激活，并在使用后 停用。如果此要求过于繁琐，建议的替代方案是将软件安装到 用户环境 中。有关更多信息，请参阅下面的完整安装程序。

安装程序

• 对于包含 Python 作为操作系统核心部分的 MacOSX 和 Linux 系统，强烈建议将此软件安装到 虚拟环境 或 用户环境 中，以免与操作系统的 Python 安装发生干扰或冲突。Python3 的原生 venv 模块、PyPi 的 virtualenv 软件包或 Anaconda Distribution 环境都可以用作虚拟环境。

• 除了使用虚拟环境，也可以在调用 pip install 时使用 --user 参数，将软件安装到 用户环境 中。

• 推荐使用最新版本的 pip、setuptools 和 wheel。如果这些组件已经安装，更新到最新版本是 可选的。

安装顺序

1. 创建并/或激活目标虚拟环境（如果有）。此步骤针对使用的虚拟环境类型。

2. 更新 pip、setuptools 和 wheel（可选）。

   1. 对于 虚拟环境 执行以下操作（确保环境是 激活的）

      python -m pip install --upgrade pip setuptools wheel
      

   2. 对于 用户环境 执行以下操作

      python3 -m pip install --user --upgrade pip setuptools wheel
      

   3. 对于 Linux 系统上的 Python 安装，建议使用系统包管理器（如 dnf、apt 或 yum）更新以下包： python3-pip、python3-setuptools 和 python3-wheel。

3. 使用 pip install 命令直接从 PyPi 安装 deriva-client。

   1. 对于 虚拟环境 执行以下操作（确保环境是 激活的）

      pip install deriva-client
      

   2. 对于 用户环境 执行以下操作

      pip3 install --user deriva-client
      

   3. 对于系统范围内的 Python 安装（仅在您了解涉及到的复杂性时才执行）

      pip3 install deriva-client
      

重要说明：使用 pip 将软件安装到 系统范围内的 Python 位置

• 许多较新的 Linux（以及 MacOSX）发行版都预装了 Python2 和 Python3，并且它们彼此相邻。在这些环境中，Python 解释器和 pip 都被符号链接到系统默认版本，通常导致 python 和 pip 链接到 Python2 版本。
• 通常通过 python3 和 pip3 访问 Python3 版本。如果您在 Python3 虚拟环境外工作，并将软件安装到系统范围内的 Python 位置（不建议）或基于用户的定位（例如，使用 pip 的 --user 参数），则在发出 pip 安装命令时，您必须用 pip3 替换 pip。
• 注意，当通过 Linux/MacOSX 上的 pip 将软件安装到系统 Python 位置时，必须以 root 用户运行命令或必须在命令行前加上 sudo 命令。
• 请注意，当使用 pip3 的 --user 标志时，由于操作系统之间以及/或本地策略配置的各种 shell 实现差异，默认情况下可能无法自动在搜索路径中找到每个已安装程序的执行文件。因此，可能需要手动将已安装的可执行文件目录添加到搜索路径，这可能是一个操作系统、发行版和/或 shell 特定的过程。
  • 在 Linux/MacOSX 系统上，默认的可执行文件安装位置通常是 ~/.local/bin/。
  • 在 Windows 系统上，默认的可执行文件安装位置通常是 %systemroot%\<username>\AppData\Roaming\Python\Python3{x}\Scripts。

源代码

以下链接可以找到 deriva-client 主要组件的源代码和附加文档：

• deriva-py
• deriva-qt
• deriva-workbench
• deriva-catalog-manage