rightos-sdk — RightOS Python SDK
Official Python SDK for RightOS — privacy-preserving rights verification infrastructure. Issue and verify digital QR tickets ("Right Tokens") for queues, reservations, EV charging, and package pickup, without ever collecting end users' names or phone numbers.
- Zero dependencies (standard library only), Python ≥ 3.9
- Machine-readable spec: openapi.json · AI-agent docs: llms-full.txt
Links: Sign up free · Pricing · MCP setup · Use cases · Usage insights
RightOS is not a taxi or ride-hailing service. It does not arrange vehicles, set fares, assign drivers, or broker dispatch.
Install
pip install rightos-sdk
Quickstart (60 seconds)
from rightos import RightOS
# 1. Register once (the apiKey is returned EXACTLY ONCE — store it securely)
pub = RightOS()
reg = pub.register_organization(name="My Shop", contact_email="you@example.com", plan_id="free")
api_key = reg["apiKey"]
# 2. Operator client
client = RightOS(api_key=api_key)
# 3. Issue a digital QR ticket
location = client.list_locations()[0]
issued = client.issue_token(location_id=location["id"], title="Queue ticket")
print("Hand this to your customer:", issued["walletUrl"])
# 4. Verify on arrival (no API key needed)
outcome = RightOS().verify_token(issued["token"]["id"], issued["verificationCode"])
print(outcome["result"]) # "success"
# 5. Mark as used after service
client.use_token(issued["token"]["id"])
Location policies (Policy Engine)
policy = client.get_location_policy(location["id"])["policy"]
# {"transferable": True, "maxTransfers": 3, "defaultValidityMinutes": 720, ...}
client.set_location_policy(location["id"], {"transferable": False}) # override
client.set_location_policy(location["id"], None) # reset to industry preset
# The full knowledge base — industry presets and country overlays
# (JP/US/GB/KR/TW/FR/DE/IT/ES/AU, informed by local ticket-resale laws):
defs = client.list_policies() # defaults, not legal advice
Webhooks (v0.4.0+)
Receive a signed HTTPS POST whenever a token is verified, used, cancelled, or transferred (up to 3 webhooks per organization):
from rightos import RightOS, verify_webhook_signature
client = RightOS(api_key="rk_live_...")
# Register — the signing secret is returned EXACTLY ONCE
created = client.create_webhook(
"https://example.com/rightos/hook",
events=["token.verified", "token.used"], # defaults to all four
)
secret = created["secret"] # "whsec_..."
# In your receiver: verify the x-rightos-signature header against the RAW body
ok = verify_webhook_signature(secret, request.headers["x-rightos-signature"], raw_body)
# respond 2xx immediately; process asynchronously
client.list_webhooks() # never includes secrets
client.delete_webhook(created["webhook"]["id"])
Delivery is best-effort (3s timeout, no retries). Signature format: t=<unix seconds>,v1=<hex HMAC-SHA256(secret, f"{t}.{raw_body}")>.
Error handling
from rightos import RightOS, RightOSError
try:
RightOS().transfer_token(token_id, code)
except RightOSError as e:
if e.code == "policy_transfer_disabled":
... # this location forbids transfers
elif e.status == 429:
... # rate limited; wait e.retry_after_sec
Common codes: missing_api_key / invalid_api_key (401), plan limits (402), policy_transfer_disabled / transfer_limit_reached (409), rate_limited (429).
Try it against the live demo
demo = RightOS(api_key="rk_demo_00000000000000000000") # shared demo org
print(demo.list_locations())
License
MIT © I-S3 Inc.
Metadata
Release files for rightos-sdk 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rightos_sdk-0.5.1.tar.gz | 6.8 kB | With provenance | Details for rightos_sdk-0.5.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rightos_sdk-0.5.1-py3-none-any.whl | Python 3 | none | any | Details for rightos_sdk-0.5.1-py3-none-any.whl |
Total release size: 13.9 kB
Release files / rightos_sdk-0.5.1.tar.gz
| Download URL | rightos_sdk-0.5.1.tar.gz |
|---|---|
| Size | 6.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a47d6b04a643d204515a6fe03b77c68b7c7c236f7c0261c9692289d0d60ed19d
|
|
BLAKE2b-256 checksum How to use checksums |
a47b1b51a72044371498eaf7ff19feef095d6a84388977e19b5d26941cd1b1e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.
Transparency logRelease files / rightos_sdk-0.5.1-py3-none-any.whl
| Download URL | rightos_sdk-0.5.1-py3-none-any.whl |
|---|---|
| Size | 7.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
05fdce044fa19280734ea092353e69e3e6881dac945c696bf894b4d6ba736ddc
|
|
BLAKE2b-256 checksum How to use checksums |
8a0e8213ee979b783cbda941adb61ee0addb0ec157fca9aff9fa572a6ed75b36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.
Transparency logSecurity for rightos-sdk 0.5.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for rightos_sdk-0.5.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.