Skip to main content

Generated Python types export

Generated from proto/ via JSON Schema. Do not edit by hand — regenerate with scripts/gen-sdk-types.sh and commit the result (CI drift-gates it).

A types export, not a full SDK: Pydantic models + registered vocabulary constants. Transport (Connect), request signing (RFC 9421), and key management are a separate, hand-written SDK layer.

Contents:

  • wire/base.py — WireModel, the single base class every model extends (the one seam: SDK-wide config + your override point; neutral name so a protocol rename never touches consumer imports). Hand-written, not regenerated.
  • wire/models.py — Pydantic v2 models for every message (License, Pricing, LicenseTerm, Offer, …), all extending WireModel. They carry shape + per-field validation: enums (named from the proto descriptor, *_UNSPECIFIED dropped), string patterns, length/item bounds. Nested messages reference the same model (LicenseTerm.license is a License), so the whole tree hydrates as typed models. Cross-field rules are NOT here — enforced server-side by the Exchange/Broker.
  • wire/schemas.py — load(name, strict=False) and names(): the published JSON Schemas (draft 2020-12), one self-contained file per message, shipped as package data under wire/jsonschema/. strict=True selects the variant that refuses unknown fields at every depth; a conformance check uses it. The files are generated into gen/jsonschema/ (in this repository wire/jsonschema is a symlink to it), whose README records how they treat field naming, google.protobuf.Struct and 64-bit integers. Hand-written loader; needs no validator library.
  • vocab/ — registered vocabulary constants per axis (pricingunits, …) with is_registered(), plus the accepted aliases authored beside the tokens (ALIASES, canonical() — an exact lookup; the SDK folds case before it looks up).
from wire.models import LicenseTerm, License
from wire.base import WireModel          # subclass this to customize ALL models at once

term = LicenseTerm.model_validate(incoming_json)   # raises on shape/per-field violations
assert isinstance(term.license, License)           # full nested hierarchy, typed

from jsonschema import Draft202012Validator        # any draft 2020-12 validator
from wire import schemas
Draft202012Validator(schemas.load("fora.v1.LicenseTerm", strict=True)).validate(incoming_json)

Install (from this directory): pip install .

Import names and PyPI

The distribution is published on PyPI as fora-protocol. Its import packages are the generic top-level names wire and vocab, so it can collide with any other distribution that owns either name; install it into an environment that does not. This is a deliberate tradeoff: a rename to a namespaced package would break every consumer that installs from this repository by git ref, so the names stay as they are.

pip install fora-protocol

Metadata

Release files for fora-protocol 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fora-protocol 1.1.0
File Size Uploaded Provenance Actions
fora_protocol-1.1.0.tar.gz 483.6 kB Without provenance Details for fora_protocol-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fora-protocol 1.1.0
File Interpreter ABI Platform Actions
fora_protocol-1.1.0-py3-none-any.whl Python 3 none any Details for fora_protocol-1.1.0-py3-none-any.whl

Total release size: 1.2 MB

Release files / fora_protocol-1.1.0.tar.gz

Download URL fora_protocol-1.1.0.tar.gz
Size 483.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0a2f0bc23f38816568fa6d5d73745c6ac1cd103f90106b62f516f918c3637932
BLAKE2b-256 checksum
How to use checksums
88f44f8de79fb1ba76ae424ebc389c46aebe0dc656017cd401e79708e8c0f439
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.11 {"installer":{"name":"uv","version":"0.12.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / fora_protocol-1.1.0-py3-none-any.whl

Download URL fora_protocol-1.1.0-py3-none-any.whl
Size 715.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1063f2274ef0878372b5446fcb07a4bff93c509fce523cff55fa7ccaa617bb3e
BLAKE2b-256 checksum
How to use checksums
c9fd07461f15a33d7e047ca31d24475c1a4cc554d135856e92aaa63c2be194c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.11 {"installer":{"name":"uv","version":"0.12.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for fora-protocol 1.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page