Skip to main content

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

项目描述

CI 状态 文件状态 派皮包 兼容的 Python 版本 代码风格

这是一个实验性工具包,可帮助开发人员构建用于 Globus Automate 的操作提供程序,包括通过 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": "http://json-schema.org/draft-07/schema#",
        "title": "Exmaple 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 的动作提供程序,请使用pip install globus_action_provider_tools[flask]安装此库

报告问题

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

测试、开发和贡献

欢迎并感谢您抽出宝贵时间做出贡献!

globus_action_provider_tools包是使用诗歌开发的,所以要开始使用,您需要安装诗歌。安装后,克隆存储库并运行make install以在虚拟环境(通常为.venv )中本地安装包及其依赖项。

就是这样,您已准备好深入研究并进行代码更改。一旦您对更改感到满意,请务必运行make autoformat以对您的更改运行项目的自动格式化程序并进行测试以验证没有引入重大更改。必须运行这两个步骤才能让我们接受传入的更改。一旦你觉得你的工作已经准备好提交,请随时创建 PR。

PyPi 发布

创建工具包的新版本时,请按照以下步骤操作:

  • 创建一个新的发布分支
    • git checkout -b 发布/XYZ

  • 更新项目的依赖
    • 诗歌更新

  • 在 pyproject.toml 中更新项目版本(遵循语义版本控制)
    • 诗歌版补丁|次要|主要

  • 更新globus_action_provider_tools/__init__.py中的项目版本

  • 向主分支创建拉取请求,等待 CI 测试完成

  • 合并传递的拉取请求

  • 为新版本创建并发布一个 git 标签
    • git tag v$(诗歌版-s)

    • git push –标签

  • 创建一个引用最近创建的标签的新 GH 版本。提供包含变更集信息的发行说明。创建发布后,会有一个 GH 工作流来构建工具包并将其发布到 pypi。

项目详情


下载文件

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

源分布

globus-action-provider-tools-0.12.0.tar.gz (30.7 kB 查看哈希

已上传 source

内置分布

globus_action_provider_tools-0.12.0-py3-none-any.whl (37.0 kB 查看哈希

已上传 py3