Skip to main content

Python SDK for the Deployzy deploy & tunnel platform

Project description

deployzy

Official Python SDK for Deployzy — deploy & tunnel platform.

Install

pip install deployzy

Quick Start

import asyncio
from deployzy import Deployzy

async def main():
    async with Deployzy(authtoken="sm_live_...") as client:
        # List active tunnels
        tunnels = await client.tunnels.list()
        print(tunnels)

        # Get captured requests
        requests = await client.inspect.list(tunnels[0].url)
        for req in requests:
            print(f"{req.method} {req.path} -> {req.status_code} ({req.duration_ms}ms)")

asyncio.run(main())

Live Traffic Streaming

async with Deployzy(authtoken="sm_live_...") as client:
    async for req in client.inspect.subscribe("https://abc123.deployzy.com"):
        print(f"{req.method} {req.path} -> {req.status_code}")

API Keys

async with Deployzy(authtoken="sm_live_...") as client:
    # List keys
    keys = await client.api_keys.list()

    # Create a new key
    full_token, info = await client.api_keys.create("my-app")
    print(full_token)  # sm_live_... (save this!)

    # Delete a key
    await client.api_keys.delete(info.id)

Custom Domains

async with Deployzy(authtoken="sm_live_...") as client:
    # Add a domain
    domain, instructions = await client.domains.create("api.example.com")
    print(f"Add CNAME: {instructions['name']} -> {instructions['target']}")

    # Verify DNS
    result = await client.domains.verify(domain.id)
    print(result)

    # List domains
    domains = await client.domains.list()

Error Handling

from deployzy import Deployzy, AuthError, RateLimitError, ApiError

try:
    async with Deployzy(authtoken="invalid") as client:
        await client.tunnels.list()
except AuthError:
    print("Bad token")
except RateLimitError as e:
    print(f"Rate limited, retry in {e.retry_after}s")
except ApiError as e:
    print(f"API error {e.status_code}: {e}")

Self-Hosted

client = Deployzy(
    authtoken="sm_live_...",
    server_url="https://tunnel.mycompany.com",
)

License

MIT

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

deployzy-1.1.3.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

deployzy-1.1.3-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file deployzy-1.1.3.tar.gz.

File metadata

  • Download URL: deployzy-1.1.3.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for deployzy-1.1.3.tar.gz
Algorithm Hash digest
SHA256 c37d92a7ac0f2e85a86b679c9459f83019926f5913fcdeb112044530b9b0c125
MD5 23c0529cd2417d0479b351eb533a28a3
BLAKE2b-256 7438c25b8ce1df198a02ed1828bd90f9f1af5e36c2e32333ef4306d4bd4f793f

See more details on using hashes here.

Provenance

The following attestation bundles were made for deployzy-1.1.3.tar.gz:

Publisher: release.yml on jams24/deployzy

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

File details

Details for the file deployzy-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: deployzy-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for deployzy-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 add7cee14a6949267b43b94cdd525af0a7f45e49f165ea7a9d16424928e071e4
MD5 688c9ea4d9bdbe9891923f0759cea220
BLAKE2b-256 01b5e65bc2e8560a5a36eb94ffa91d1bb558b9fc9b9b28a4841c770a344a22b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for deployzy-1.1.3-py3-none-any.whl:

Publisher: release.yml on jams24/deployzy

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

Supported by

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