Skip to main content

Official Python SDK for the Plystra Kernel Phase 1 API.

Project description

plystra

Official Python SDK for the Plystra Kernel Phase 1 API.

PyPI package name: plystra Repository name: plystra/python-sdk

Requires Python 3.10 or newer.

Install

pip install plystra

Usage

Phase 1 is Context Mode: your trusted backend keeps its existing users, organizations, roles, and business rows, then calls Plystra to protect one action.

from plystra import Plystra

with Plystra("https://plystra.internal", api_key="ply_kernel_secret") as plystra:
    decision = plystra.authz.check(
        actor={
            "user_id": "user_external_alice",
            "member_id": "member_finance_reviewer",
            "binding_id": "binding_external_alice_finance",
            "space_id": "space_acme",
        },
        resource={
            "type": "invoice",
            "external_id": "invoice_001",
            "space_id": "space_acme",
            "group_path": "finance.apac",
            "owner_member_id": "member_invoice_creator",
        },
        grants=[{
            "role_key": "finance_approver",
            "resource": "invoice",
            "action": "approve",
            "scope": "group_tree",
            "space_id": "space_acme",
            "scope_anchor_group_path": "finance",
        }],
        action="approve",
        explain=True,
    )

Inline actor, resource, and grant context is trusted server-side input. Build it from your authenticated session and database state, never directly from browser-submitted JSON.

Async Usage

import asyncio
from plystra import AsyncPlystra


async def main() -> None:
    async with AsyncPlystra("https://plystra.internal", api_key="ply_kernel_secret") as plystra:
        print(await plystra.system.capabilities())


asyncio.run(main())

Kernel Surfaces

  • system.health(), system.ready(), system.version()
  • system.capabilities()
  • resource_types.list()
  • authz.check() and authz.explain()
  • audit.list() and audit.get()
  • request() for low-level calls

Attach a correlation id to a group of calls:

scoped = plystra.with_request_id("req_01HY...")
scoped.authz.explain(**context_mode_request)

Protected routes require a scoped server API key. Public health, readiness, and version checks do not send the key.

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

plystra-1.0.0rc121.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

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

plystra-1.0.0rc121-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file plystra-1.0.0rc121.tar.gz.

File metadata

  • Download URL: plystra-1.0.0rc121.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for plystra-1.0.0rc121.tar.gz
Algorithm Hash digest
SHA256 fbb79f865e76a630d01262cf4c57971ad3c4d5cd4de575673b03aacda1804a0a
MD5 afbba944492fd04d429af00c6d6861d6
BLAKE2b-256 dc62987801cd6a3ab9a30e11b03689707a6569952effb57a2d49a10382324ba2

See more details on using hashes here.

Provenance

The following attestation bundles were made for plystra-1.0.0rc121.tar.gz:

Publisher: publish.yml on plystra/python-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 plystra-1.0.0rc121-py3-none-any.whl.

File metadata

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

File hashes

Hashes for plystra-1.0.0rc121-py3-none-any.whl
Algorithm Hash digest
SHA256 921957a726f694acdacb9d7920900e8062807bd5908f72ce205c6d57c4f07a6e
MD5 b16864b5b4f1a25987d1972c9bc2d7d3
BLAKE2b-256 1a70e156ff8f81aee5bbc9fa32e0372c97ca809a5d21bf83250d9d8afbca2b72

See more details on using hashes here.

Provenance

The following attestation bundles were made for plystra-1.0.0rc121-py3-none-any.whl:

Publisher: publish.yml on plystra/python-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