跳转到主要内容

帮助开发者构建实现Action Provider规范的服务的工具。

项目描述

这是一个实验性工具包,旨在帮助开发者构建用于 Globus Automate 的 Action Providers,包括通过 Globus Flows 调用。

由于这是实验性的,不提供对该包任何使用形式的任何支持。它发布是为了方便那些打算为其实验性目的使用它的人分发。

基本用法

使用 pip install globus_action_provider_tools 安装基础工具包

然后,您可以从 globus_action_provider_tools 导入工具包的独立组件。这在您想使用库的一部分执行功能(例如通过 TokenChecker 进行令牌验证或通过 ActionStatus 或 ActionRequest 进行 API 模式验证)并将其插入其他 Web 框架的情况下非常有用。

from flask import Flask
from globus_action_provider_tools import ActionProviderDescription

description = ActionProviderDescription(
    globus_auth_scope="https://auth.globus.org/scopes/00000000-0000-0000-0000-000000000000/action_all",
    title="My Action Provider",
    admin_contact="support@example.org",
    synchronous=True,
    input_schema={
        "$id": "whattimeisitnow.provider.input.schema.json",
        "$schema": "https://json-schema.fullstack.org.cn/draft-07/schema#",
        "title": "Example Action Provider",
        "type": "object",
        "properties": {"message": {"type": "string"}},
        "required": ["message"],
        "additionalProperties": False,
    },
    api_version="1.0",
    subtitle="Just an example",
    description="",
    keywords=["example", "testing"],
    visible_to=["public"],
    runnable_by=["all_authenticated_users"],
    administered_by=["support@example.org"],
)

要安装 Flask 辅助工具以便专门用于开发基于 Flask 的 Action Providers,请使用 pip install globus_action_provider_tools[flask] 安装此库

问题报告

如果您在使用 globus_action_provider_tools 时遇到问题,或者有改进工具包的想法,请在仓库中打开一个问题并分享您的反馈。

测试、开发和贡献

欢迎,并感谢您抽出时间进行贡献!

要开始,您需要克隆仓库并运行 make install 以在虚拟环境(.venv/)中本地安装该包及其依赖项。

然后,激活虚拟环境

$ source .venv/bin/activate

这样,您就准备好深入代码进行更改了。运行 make test 以验证没有引入破坏性更改。一旦您觉得您的作品可以提交,请随意创建一个 PR。

项目详情


下载文件

下载您平台所需的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

globus_action_provider_tools-0.18.0.tar.gz (32.8 kB 查看哈希值)

上传时间 源代码

构建分发

globus_action_provider_tools-0.18.0-py3-none-any.whl (41.6 kB 查看哈希值)

上传时间 Python 3