Skip to main content

VWP Python SDK — primitives for vibe-coded backends (rate limiting, auth, notifications, and more).

Project description

vwp-sdk

Python SDK for VWP — primitives for vibe-coded backends.

pip install vwp-sdk

Quickstart

import vwp

client = vwp.Client(api_key="vwp_test_...")  # or set VWP_API_KEY in env

result = client.rate_limit.check(
    key="login:user@example.com",
    limit=5,
    window="15m",
)
if not result.allowed:
    # Block this request — your handler returns 429 to the end user.
    print(f"Try again in {result.retry_after_seconds}s")

Or, async:

import asyncio
import vwp

async def main():
    async with vwp.AsyncClient(api_key="vwp_test_...") as client:
        result = await client.rate_limit.check(
            key="login:user@example.com", limit=5, window="15m",
        )
        print(result)

asyncio.run(main())

What's in this release (0.2.0a1)

  • vwp.rate_limit.check(...)SECURITY-RATE-LIMIT-001, fully wired against https://api.vibewithprimitiveai.com/v1.
  • vwp.auth.magic_link.request(email, return_to, ...) — issues a single-use magic link via email (Azure Communication Services on our side).
  • vwp.auth.magic_link.exchange(request | url | dict, handle?) — turns a clicked link into a signed JWT session. SDK pulls _vwp_h out of the request URL automatically.
  • vwp.Client / vwp.AsyncClient — explicit clients for connection reuse.
  • Typed errorsApiKeyError (401), BadRequestError (400), MetaRateLimitedError (429), ServerError (5xx), NetworkError (no response).

Other modules (vwp.notify, vwp.data, vwp.queue) are present as stubs and will be implemented in subsequent releases. Calling them raises NotImplementedError with a pointer to the docs.

Magic-link quickstart

import vwp

client = vwp.Client(api_key="vwp_test_...")

# Step 1 — user types their email
r = client.auth.magic_link.request(
    email="user@example.com",
    return_to="https://yourapp.com/dashboard",
)
# r.expires_at — when the link expires (default 15 min)
# r.delivery_status — "queued"

# Step 2 — user clicks the link, your callback handler runs:
session = client.auth.magic_link.exchange(request)  # request from your framework
# Or pass the URL/handle directly:
session = client.auth.magic_link.exchange(handle="<_vwp_h value from URL>")

# session.session.user_id, session.session.email — for your user table upsert
# session.jwt — set as a HttpOnly cookie

Errors

Every error subclasses vwp.VWPError. Catch the base class to handle anything:

try:
    result = vwp.rate_limit.check(key="...", limit=5, window="15m")
except vwp.ApiKeyError as e:
    print("Bad API key:", e.request_id)
except vwp.BadRequestError as e:
    print("Bad input:", e.field, e.message)
except vwp.VWPError as e:
    print("Other VWP error:", e)

Compatibility

Python 3.9+. Production-tested on 3.12.

License

Apache-2.0.

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

vwp_sdk-0.3.0a1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

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

vwp_sdk-0.3.0a1-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file vwp_sdk-0.3.0a1.tar.gz.

File metadata

  • Download URL: vwp_sdk-0.3.0a1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for vwp_sdk-0.3.0a1.tar.gz
Algorithm Hash digest
SHA256 5c65678bb31460898c0812d448c16ab8b3c0e98d9812f01e3a3fd05d9499cd6c
MD5 c78637453e6a46049aa7a26efcf83ee0
BLAKE2b-256 53db138471428e69fe7556918602ebe26e5e2b01d5743975a07445ffd97a0008

See more details on using hashes here.

File details

Details for the file vwp_sdk-0.3.0a1-py3-none-any.whl.

File metadata

  • Download URL: vwp_sdk-0.3.0a1-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for vwp_sdk-0.3.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f3a19681f6a6ccf039c600ba3f4d74d534b8c16b51143e3546a416fc301f84d
MD5 1af38a83ec5a1a396b3f63d0bfc75547
BLAKE2b-256 73e9aaa3ca22cc1da4edc6b44657c076d126803a24c1ba8ca68a9586a8b0ba1d

See more details on using hashes here.

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