Skip to main content

Tools to help developers build services that implement the Action Provider specification.

Project description

CI Status Documentation Status PyPi Package Compatible Python Versions

This is an experimental toolkit to help developers build Action Providers for use in Globus Automate including for invocation via Globus Flows.

As this is experimental, no support is implied or provided for any sort of use of this package. It is published for ease of distribution among those planning to use it for its intended, experimental, purpose.

Basic Usage

Install with pip install globus_action_provider_tools

You can then import the toolkit’s components and helpers from globus_action_provider_tools. For example:

from flask import Flask
from globus_action_provider_tools.data_types import (
    ActionProviderDescription)

# Create an 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"],
)

Reporting Issues

If you’re experiencing a problem using globus_action_provider_tools, or have an idea for how to improve the toolkit, please open an issue in the repository and share your feedback.

Testing, Development, and Contributing

Welcome and thank you for taking the time to contribute!

The globus_action_provider_tools package is developed using poetry so to get started you’ll need to install poetry. Once installed, clone the repository and run make install to install the package and its dependencies locally in a virtual environment (typically .venv).

And that’s it, you’re ready to dive in and make code changes. Once you’re satisfied with your changes, be sure to run make test and make lint as those need to be passing for us to accept incoming changes. Once you feel your work is ready to be submitted, feel free to create a PR.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for globus-action-provider-tools, version 0.10.1
Filename, size File type Python version Upload date Hashes
Filename, size globus_action_provider_tools-0.10.1-py3-none-any.whl (33.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size globus-action-provider-tools-0.10.1.tar.gz (26.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page