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.10.4.tar.gz (28.0 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.10.4-py3-none-any.whl (35.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: globus-action-provider-tools-0.10.4.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.3 CPython/3.6.12 Linux/5.4.0-1026-azure

File hashes

Hashes for globus-action-provider-tools-0.10.4.tar.gz
Algorithm Hash digest
SHA256 b1092db4720879deb15805b5b5e8b8797e9e02664dfcc8fadde3b6dde82da5ef
MD5 00c697bc08dce218caa041ead66e4f82
BLAKE2b-256 bea9326a3722978ded2718220c4a184408a7b78b85860ec89b81a0f7d14aca77

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for globus_action_provider_tools-0.10.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5d37bf6af2538404445e7c809267e0cdd3d9e874f6f44aed8ee0cefecf516dac
MD5 d21f799a930341a0bca51b1a125f3885
BLAKE2b-256 689f93836bea106b5ef37cd355f3e3d44426e562cd8a2c0eed84adb7140160f3

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