Skip to main content

A Python library for integrating with various workflow providers

Project description

UniWorkflow

English Version | 中文版

UniWorkflow is a Python library that provides a unified interface for integrating with various workflow providers such as Make.com and Dify.

Installation

You can install UniWorkflow using pip:

pip install uniworkflow

Quick Start

Run a make.com workflow

Here's a simple example of how to use UniWorkflow:

# import the library
from uniworkflow import UniwWorkflow

# prepare the kwargs
kwargs = {
    "workflow_url": "https://example.make.com/your-workflow-hook",
    "method": "GET",
    "api_key": "your_api_key_here",
    "data": {"key1": "value1", "key2": "value2", ......},
}

# Execute a workflow
result = UniwWorkflow.execute("make", **kwargs)

# print the result
print(result)

Run a dify workflow

# import the library
from uniworkflow import UniwWorkflow

# prepare the kwargs
kwargs = {
    "workflow_url": "https://api.dify.ai/v1/workflows/run",
    "method": "POST",
    "api_key": "your_api_key_here",
    "data": {"key1": "value1", "key2": "value2", ......},
}

# Execute a workflow
result = UniwWorkflow.execute("dify", **kwargs) 

# print the result
print(result)

Parameters

  • workflow_url: The URL of the workflow to execute.
  • method: The HTTP method to use (GET, POST, etc.).
  • api_key: The API key to use for the workflow.
  • data: The data to pass to the workflow.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Running Tests

To run the tests for UniWorkflow, you can use pytest. Make sure you have pytest installed and replace the parameters in the test cases with your own.

pip install pytest

Then, run the tests:

pytest -s tests/test_make.py
pytest -s tests/test_dify.py

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

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

Source Distribution

uniworkflow-0.1.2.tar.gz (17.9 kB view hashes)

Uploaded Source

Built Distribution

uniworkflow-0.1.2-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page