cloudcruise-python

PyPI - Version PyPI - Downloads

The official CloudCruise Python SDK for automated browser workflows, encrypted credential management, realtime run monitoring, and webhook verification.

Installation

pip install cloudcruise

Python 3.10 or newer is required. The package ships with type hints (py.typed).

Quick Start

from cloudcruise import CloudCruise, CloudCruiseParams, StartRunRequest

client = CloudCruise(
    CloudCruiseParams(
        api_key="<CLOUDCRUISE_API_KEY>",
        encryption_key="<CLOUDCRUISE_ENCRYPTION_KEY>",
    )
)
# Alternatively, set CLOUDCRUISE_API_KEY and CLOUDCRUISE_ENCRYPTION_KEY
# environment variables and instantiate with `client = CloudCruise()`.

run = client.runs.start(
    StartRunRequest(
        workflow_id="105b7ae1-ce62-4a5c-b782-b4b0aec5175a",
        run_input_variables={"email": "test@example.com"},
    )
)

# Listen to specific event types (recommended - clean and type-safe)
run.on("execution.start", lambda e: print(f"Workflow started: {e.payload['workflow_id']}"))
run.on("execution.step", lambda e: print(f"Step: {e.payload['current_step']}"))
run.on("execution.success", lambda e: print(f"Success! Output: {e.payload.get('data')}"))
run.on("end", lambda info: print(f"Run completed: {info['type']}"))

# Or use generic listener for all events (flattened structure)
# run.on("run.event", lambda event: print(f"{event.type}: {event.payload}"))

# Block until the run finishes and fetch final results
result = run.wait()
print(result.status, result.data)

Environment variables CLOUDCRUISE_API_KEY, CLOUDCRUISE_ENCRYPTION_KEY are also supported via lazy cloudcruise.client().

Clients

Client	Description	Module Docs
Vault	AES-256-GCM credential storage and retrieval utilities	`cloudcruise.vault`
Workflows	Workflow definitions, metadata, and input validation	`cloudcruise.workflows`
Runs	Workflow execution with SSE-based realtime streaming	`cloudcruise.runs`
Webhook	Webhook payload verification and helpers	`cloudcruise.webhook`

All clients are accessible via CloudCruise or the convenience cloudcruise.client() singleton.

Development

This project uses standard Python tooling with setuptools. See CONTRIBUTING.md for comprehensive instructions.

Quick start:

python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -e ".[dev]"  # installs package + dev dependencies

# Run the unit test suite
python -m unittest discover -s tests -p "test_*.py" -v

For live staging tests, export CLOUDCRUISE_API_KEY and CLOUDCRUISE_ENCRYPTION_KEY, then run python -m unittest discover -s tests -p "test_live_staging.py" -v.

Documentation & Resources

API Documentation – Full platform reference
CloudCruise Platform – Product overview
Agents & Assistant Context – How this repository’s automation assistant operates

License

MIT

License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
- Python :: 3
- Python :: 3 :: Only
Typing
- Typed

Download files

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

Source Distribution

cloudcruise-1.3.1.tar.gz (45.2 kB view details)

Uploaded Aug 9, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cloudcruise-1.3.1-py3-none-any.whl (39.7 kB view details)

Uploaded Aug 9, 2026 Python 3

File details

Details for the file cloudcruise-1.3.1.tar.gz.

File metadata

Download URL: cloudcruise-1.3.1.tar.gz
Upload date: Aug 9, 2026
Size: 45.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for cloudcruise-1.3.1.tar.gz
Algorithm	Hash digest
SHA256	`9cb6a29f17e20c6835a8e6dbedaea87a8b632d7a8d0aec2a6410209dc7940343`
MD5	`b260a255f8224af9115447ff47208d0a`
BLAKE2b-256	`ca1bdc13e1a4d2846cb36f55e640dbb8f2c2b18387f1ddd6e2e86cfcea3211e4`

See more details on using hashes here.

Provenance

The following attestation bundles were made for cloudcruise-1.3.1.tar.gz:

Publisher: publish.yml on CloudCruise/cloudcruise-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: cloudcruise-1.3.1.tar.gz
- Subject digest: 9cb6a29f17e20c6835a8e6dbedaea87a8b632d7a8d0aec2a6410209dc7940343
- Sigstore transparency entry: 2398660652
- Sigstore integration time: Aug 9, 2026
Source repository:
- Permalink: CloudCruise/cloudcruise-python@2019e9f82156030b61fdc4e4472c90e94d11df07
- Branch / Tag: refs/heads/main
- Owner: https://github.com/CloudCruise
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@2019e9f82156030b61fdc4e4472c90e94d11df07
- Trigger Event: push