Skip to main content

RevTurbine SDK for Python — local-mode and HTTP-mode placement and entitlement decisioning

Project description

RevTurbine SDK — Python

Headless, in-memory entitlement and placement decisioning for Python services. RevTurbineCustomerSdk (plan 33 TASK-7) decides in-process from a caller-supplied user context + ExportedConfig snapshot — no network, no persistence beyond memory. Its decision output is byte-identical to the canonical TypeScript LocalRuntime (cross-language parity is gate-enforced via revturbine-sdk-internal/tests/parity/).

Full docs: the published Astro docs site — Getting Started → Python SDK (source: pages-build/src/content/docs/getting-started/python.mdx).

Install

Published as a GitHub Release on revt-eng/revturbine-external (the customer-accessible repo — there is no PyPI). Requires Python ≥ 3.10. revturbine-external is private, so fetch the wheel authenticated, then install the file:

gh release download python-v0.1.0 \
  --repo revt-eng/revturbine-external \
  --pattern "revturbine-*.whl"
pip install ./revturbine-*.whl

A plain pip install <url> will not work — private-repo release assets require authentication. (Contributors developing in this repo use the editable install under Local development instead.)

Quick start

import json
from revturbine import RevTurbineCustomerSdk

with open("playbook.json") as f:
    exported_config = json.load(f)

sdk = RevTurbineCustomerSdk(
    user_context={"tenant_id": "tenant_abc", "user_id": "user_123", "plan_handle": "pro"},
    exported_config=exported_config,
)

if not sdk.check_entitlement("advanced_analytics")["allowed"]:
    raise PermissionError("not entitled")

decision = sdk.get_placement_decision(
    {"placement_id": "pl_dashboard_upsell", "user_id": "user_123"}
)

Public API

  • RevTurbineCustomerSdk(*, user_context, exported_config) — keyword-only; user_context requires tenant_id + user_id (optional plan_handle, plan_name, usage). Stateless / in-memory — no storage parameter.
  • check_entitlement(handle, context=None) -> EntitlementCheckResult
  • get_placement_decision(input) -> PlacementDecision
  • get_placement_decisions(inputs) -> list[PlacementDecision]

That is the entire public surface. Browser/full-SDK concerns (React, hooks, HTTP/dual-mode, decision cache, segment/targeting derivation, identify/dismiss/snooze/convert/get_trial_status/capture/…) are intentionally not ported — plan 33 REQ-14 non-goals.

Project layout

server-python/
├── pyproject.toml          ← package metadata + tool config (ruff, mypy, pytest)
├── tox.ini                 ← test/lint/type matrix
├── .pre-commit-config.yaml ← ruff + mypy hooks (scoped to this dir)
├── src/revturbine/         ← the headless SDK (sdk.py + core/ port)
├── revturbine_server/      ← legacy thin-RPC client (see below)
└── tests/                  ← pytest suite (incl. tests/test_public_api.py)

Legacy revturbine_server

A historical thin-RPC HTTP client (from revturbine_server import RevTurbineServer) also ships in this package. It is independent of and unrelated to RevTurbineCustomerSdk — not folded in, not a dual-mode of it. It currently depends on an unmaintained generated revturbine.types module (plan REQ-4 / TASK-2) and is not standalone-importable until that generator lands. Prefer RevTurbineCustomerSdk for all new server integrations.

Local development

pip install -e ".[dev]"
pytest                  # unit + smoke + parity-contract tests
mypy                    # strict type-check of src/ and tests/
ruff check src tests    # lint (CI scope)
ruff format --check src tests
tox                     # full matrix (py310–py313 + lint + type)

Cross-language parity (run from the SDK repo root):

node scripts/run-parity.mjs   # TS + Python runners, byte-diff (the gate)

Dependencies

  • Runtime: pydantic>=2.0.
  • Stdlib only otherwise. The legacy revturbine_server client uses only urllib / json / uuid (plus the unmaintained generated-types import noted above).

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

revturbine-0.2.40.tar.gz (164.8 kB view details)

Uploaded Source

Built Distribution

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

revturbine-0.2.40-py3-none-any.whl (130.8 kB view details)

Uploaded Python 3

File details

Details for the file revturbine-0.2.40.tar.gz.

File metadata

  • Download URL: revturbine-0.2.40.tar.gz
  • Upload date:
  • Size: 164.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for revturbine-0.2.40.tar.gz
Algorithm Hash digest
SHA256 0d85a8ef251776d18f7176c765cf9b2a690152091839d1c93a06cc97a54dbcfe
MD5 3dc713203ccc3830c4023473f0e4676a
BLAKE2b-256 bc08ac2c90790fd1a9deb5f1e0f20e135669bc4ea8907e09832be9f9b4711350

See more details on using hashes here.

Provenance

The following attestation bundles were made for revturbine-0.2.40.tar.gz:

Publisher: release-pypi.yml on revt-eng/revturbine-sdk

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

File details

Details for the file revturbine-0.2.40-py3-none-any.whl.

File metadata

  • Download URL: revturbine-0.2.40-py3-none-any.whl
  • Upload date:
  • Size: 130.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for revturbine-0.2.40-py3-none-any.whl
Algorithm Hash digest
SHA256 61e85494e1cd5d0084c56ee4885f4be86c9c020ec009fb3610a3a03bd1dabe8b
MD5 e6c6de085f6c51c806b5b2c2bdad5996
BLAKE2b-256 2d1ba82a784d4466bd769b0ae935d60152ebe7916e6115bfe15a881d6434e482

See more details on using hashes here.

Provenance

The following attestation bundles were made for revturbine-0.2.40-py3-none-any.whl:

Publisher: release-pypi.yml on revt-eng/revturbine-sdk

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