---
id: shuffle-sdk
version: "0.0.40"
license: MIT
license_treatment: permissive
maintenance: active
---

# shuffle-sdk — The SDK used for Shuffle

License: permissive · Maintenance: active · Downloads: 95.3K/mo

## What it is and what it does

Shuffle SDK is a Python application framework designed for building apps that run within the Shuffle automation and orchestration platform. It provides a base class (AppBase) that handles the boilerplate for app initialization, parameter handling, and integration with Shuffle's execution environment. Apps built with this SDK can be tested locally via command-line, deployed as Docker containers, run in Kubernetes clusters, or executed in serverless environments.

The SDK includes support for Liquid templating filters, integration with Shuffle's action system, and testing modes that allow you to invoke specific app functions with custom parameters. It depends on common HTTP and web libraries (requests, urllib3, flask, waitress) for networking and web serving, plus PyJWT for authentication, python-dateutil for time handling, and liquidpy for template processing. The framework is designed to work both standalone for testing and as part of the larger Shuffle platform for production automation workflows.

Use it for:

- Build custom integration apps for the Shuffle platform that connect external services or APIs to automation workflows.
- Test Python app functions locally before deploying them to Shuffle using the --standalone flag with custom parameters.
- Create Liquid template filters to extend Shuffle's data transformation capabilities within app functions.
- Deploy containerized Python applications that run as part of Shuffle's orchestration system across different infrastructure.
- Execute Python code dynamically within Shuffle workflows using the SDK's app execution and parameter passing mechanisms.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Shuffle SDK provides a framework for building, testing, and deploying Python applications within the Shuffle automation platform, supporting manual runs, Docker, Kubernetes, and serverless environments.

Yes, if you are developing apps for the Shuffle automation platform or need a framework for building Python applications that integrate with Shuffle's workflow engine. The low install friction, active maintenance, permissive MIT license, and no known vulnerabilities make it a safe choice. No, if you are not using Shuffle or do not need its specific app execution model and templating features.

## Install

pip install shuffle-sdk
uv add shuffle-sdk
poetry add shuffle-sdk

## Installing shuffle-sdk

Before you install: Low install friction with a pure-Python wheel distribution. Active maintenance with recent releases; last commit 2026-08-14 and 2411 repository stars indicate ongoing development and community engagement.

License in practice: MIT license is permissive and imposes minimal restrictions; you can use, modify, and distribute this package with attribution, making it suitable for both open-source and commercial projects.

Quickstart:

pip install shuffle_sdk

from shuffle_sdk import AppBase

class Example(AppBase):
    def sample_function(self, paramname):
        return f"Hello {paramname}"

if __name__ == "__main__":
    Example.run()

Requires Python 3.7 or later; intended for use within the Shuffle platform or for standalone testing of Shuffle apps.

Verify before relying:

- Whether the 9 runtime dependencies (including flask, requests, liquidpy, PyJWT) are all required for basic app development or only for specific features.
- Compatibility and testing requirements for the Shuffle platform version this SDK targets.
- Performance characteristics when running apps in different execution environments (Docker vs. k8s vs. serverless).

## Package facts

- License: MIT (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 95.3K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

shuffle app development framework, automation workflow app sdk, python app testing framework, docker kubernetes app deployment, serverless automation platform sdk, automation-framework, workflow-orchestration

[View on SkillFed](https://skillfed.io/packages/shuffle-sdk) · [View on PyPI](https://pypi.org/project/shuffle-sdk/)