Registry / devops / shuffle-sdk

shuffle-sdk

JSON →
library0.0.40pypypi✓ verified 81d ago

The Python SDK for Shuffle, an open-source SOAR (Security Orchestration, Automation, and Response) platform. Current version 0.0.38, updated irregularly. This SDK allows programmatic interaction with the Shuffle API, including actions like creating workflows, executing rules, and managing apps.

pip install shuffle-sdk
INSTALL
IMPORT
SIG · SHUFFLE-SDK
S
shuffle-sdk
devopspythonv0.0.40
Install
3.4s avg
Import
Disk
28MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v0.0.40 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 28.8MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 3.4s · import 0.000s · 29MB
28MB installed
● package 28MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

AppBase
from shuffle_sdk import AppBase
from shuffle import Shuffle
csv_parse
from shuffle_sdk import csv_parse
from shuffle import Shuffle
shuffle_sdk
import shuffle_sdk
from shuffle import Shuffle

Initialize the Shuffle client with your API key and base URL.

from shuffle import Shuffle import os api_key = os.environ.get('SHUFFLE_API_KEY', '') shuffle = Shuffle(api_key=api_key, base_url='https://shuffle-api.example.com') # Example: list workflows workflows = shuffle.get_workflows() print(workflows)
Debug
Known issues
gotchaThe Shuffle SDK uses HTTP Basic Auth with the API key, not Bearer tokens. Setting the wrong auth header will cause 401 errors.
fix
Pass api_key as the only credential; do not set Authorization header manually.
affects: >=0.0.1
deprecatedThe method 'create_workflow' in versions <0.0.30 accepted a single dict argument. In 0.0.38, it expects keyword arguments for 'name', 'description', etc.
fix
Update calls to use keyword arguments: create_workflow(name='test', description='...')
affects: >=0.0.1, <0.0.38
gotchaThe PyPI package name is 'shuffle-sdk', but the import package is 'shuffle'. This mismatch often causes confusion and ImportError.
fix
Install with 'pip install shuffle-sdk' but import as 'from shuffle import Shuffle'.
affects: >=0.0.1
gotchaAPI rate limits are not documented by the Shuffle server. Users have reported sudden 429 errors, especially when polling workflows quickly.
fix
Implement exponential backoff retry logic for API calls.
affects: >=0.0.1
Upgrade
Version history
0.0.40latest on PyPI · released Jun 10, 2026
Audit
Dependencies
requestsrequiredHTTP client for API calls
Agent activity
20 hits · last 30 days
node
16
OpenAI (training)
1
Resources