Skip to main content
CI Status Documentation Status PyPi Package Compatible Python Versions Code Style

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.

Download files

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

Source Distribution

globus-action-provider-tools-0.11.0.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

globus_action_provider_tools-0.11.0-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file globus-action-provider-tools-0.11.0.tar.gz.

File metadata

  • Download URL: globus-action-provider-tools-0.11.0.tar.gz
  • Upload date:
  • Size: 30.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.8.5 Linux/5.8.0-43-generic

File hashes

Hashes for globus-action-provider-tools-0.11.0.tar.gz
Algorithm Hash digest
SHA256 9b0973d0a7cd0da713307b20f8c36110a73c1a11de8174bc6127a14bf593ee80
MD5 245d2845d2075425d3898bed73545818
BLAKE2b-256 ec85ba71abc65f54344f0a3ab549e66121cf0de59c92e7ff5c495b496f3afc9a

See more details on using hashes here.

File details

Details for the file globus_action_provider_tools-0.11.0-py3-none-any.whl.

File metadata

File hashes

Hashes for globus_action_provider_tools-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8732a4952314f700dca68956bebe46c913f8ec308d554a023163ff1b823593b8
MD5 65bd0f684d007ad13663957c4954e210
BLAKE2b-256 b3aef1253bdd85ffb1fca9830aee184f89ef4ce2b5ed37ba819886d88edea0f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page