VCollab USD Report Schema
Codeless OpenUSD schema for the VCollab report model, the slides of a report and the deck that arranges them: schema source, generated plugin, synthetic fixtures and a validator
Overview
A VCollab report is a set of slides made from one or more models. It is defined by its variables and its workflow, which are stored as JSON; everything else is produced by running the workflow, and the server holds that as a USD stage. This package defines the part of that stage that holds the slides and the deck.
The stage keeps two things apart. The list holds every slide and
section, flat, each named by a prim path that never changes. The deck
is a tree of nodes under /Report/deck that arranges some of them: each
node places one item, nesting is the hierarchy, and the order of a node's
children is the order of the deck. Renaming, reordering or moving an item
touches its name or the nodes, never its path. A slide the deck does not
reach is a view kept while working.
This package ships that schema as a codeless USD plugin, the declarations
it is generated from, three fixture reports that each exercise one group of
contracts, authoring helpers that make the changes the viewer protocol's
deck actions call for, and the validator a server-built stage must pass
unchanged. It is a sibling of vcti-usd-schema-delivery, which describes a
model. The schema is a candidate, and a slide's content, the capture of the
screen, is not designed yet: a slide today is a name and the user's
attributes.
Installation
pip install vcti-usd-schema-report
In requirements.txt
vcti-usd-schema-report>=0.1.0
In pyproject.toml dependencies
dependencies = [
"vcti-usd-schema-report>=0.1.0",
]
Quick Start
Validate a stage
from vcti.usd.schema.report import open_fixture, validate
stage = open_fixture("results_deck")
errors = validate(stage)
print(errors) # [] for a conforming stage
open_fixture and open_stage register the plugin first. Any failure is
one string: the path of the prim it concerns, then a short stable phrase.
Open your own stage with the plugin registered
from pxr import Usd
from vcti.usd.schema.report import fixture_path, register_plugin
register_plugin()
stage = Usd.Stage.Open(str(fixture_path("nested_sections")))
report = stage.GetPrimAtPath("/Report")
print(report.GetTypeName(), report.GetAttribute("vct:schemaVersion").Get())
Registration is explicit and idempotent, and it also registers every
installed sibling schema, such as the delivery schema's. USD only knows the
plugins registered before it first looks up a typed prim, so a process that
opens stages itself calls register_plugin() before the first one.
Build and edit a report
The helpers take the prim name of anything they create, because allocating it is the server's rule, and return the item's path, its identity from then on.
from vcti.usd.schema.report import (
DECK_PATH,
Position,
add_section,
add_slide,
logical_path,
move_item,
new_report_stage,
rename_item,
validate,
)
stage = new_report_stage()
deck = Position(parent=DECK_PATH)
overview = add_slide(stage, "s1", "Overview", position=deck)
results = add_section(stage, "k1", "Results", position=deck)
stress = add_slide(stage, "s2", "Stress", {"load_case": "LC1"}, Position(parent=results))
kept = add_slide(stage, "s3", "Before the change") # in the list, not in the deck
rename_item(stage, results, "Findings")
move_item(stage, overview, Position(after=stress))
print(stress, logical_path(stage, stress)) # /Report/slides/s2 /Findings/Stress
print(validate(stage)) # []
From the command line
vcti-usd-report-validate report.usda other.usda
One line per stage, PASS or FAIL, each failure indented beneath it, and
a non-zero exit status when any stage fails or cannot be opened.
Key API
| Name | What it does |
|---|---|
register_plugin() |
Register the shipped codeless plugin, and every installed sibling schema's, with this process, once |
open_stage(path), open_fixture(name) |
Open with the plugin registered |
validate(stage), validate_file(path) |
Every contract the schema states, as a list of messages |
new_report_stage(path) |
A stage holding an empty report |
add_slide, add_section, duplicate_slide, duplicate_section |
New items, optionally placed in the deck |
rename_item, move_item, remove_item, set_attributes |
Changes to an item or to where it is |
Position(parent=…), Position(after=…), Position(before=…) |
Where an item goes in the deck |
node_of(stage, item), logical_path(stage, item) |
An item's node, and the path rules look it up by |
fixture_path(name), fixture_paths(), FIXTURE_NAMES, build_fixtures(dir) |
The three shipped reports, and writing them again |
render_schema(), write_schema(path) |
The schema.usda text, from the declarations |
SCHEMA_VERSION, REPORT_PATH, DECK_PATH, ITEM_TYPES, … |
The fixed names |
The types:
| Type | Properties | Purpose |
|---|---|---|
VctReport |
uniform string vct:schemaVersion |
Anchor for one report, at /Report |
VctSlide |
string vct:name; attr:* |
One slide, under /Report/slides |
VctSection |
string vct:name; attr:* |
One section, under /Report/sections |
VctDeck |
none | The hierarchy's fixed root, /Report/deck |
VctDeckNode |
rel vct:item |
Places one slide or section in the deck |
The fixtures, in reading order:
| Fixture | Scenario | Contracts it exercises |
|---|---|---|
results_deck |
Three slides, one section | The list beside the hierarchy, a slide outside the deck, a user attribute |
nested_sections |
Sections inside sections | Depth and order, an empty section, a section outside the deck, repeated names, scalar attribute types |
working_views |
Two slides, nothing arranged | An empty deck; the scopes and the deck are always present |
Dependencies
usd-core26.11 or later within the 26 series, the OpenUSD Python distribution. The shipped plugin was generated by that version'susdGenSchema, so a new major is admitted only after regeneration.jinja2, in theschemaextra, only to regenerate the plugin.
It does not depend on vcti-usd-schema-delivery.
Documentation
| If you want to… | Read |
|---|---|
| Get started using the package | Quick Start above |
| Build, edit and read a report, fixture by fixture | docs/patterns.md |
| Understand the list, the deck and the decisions behind them | docs/design.md |
| Navigate and understand the source | docs/source-guide.md |
| Add a type, a property, a check, an action or a fixture | docs/extending.md |
| See what changed | CHANGELOG.md |
Metadata
Release files for vcti-usd-schema-report 0.1.0
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 |
|---|---|---|---|---|
| vcti_usd_schema_report-0.1.0.tar.gz | 43.4 kB | With provenance | Details for vcti_usd_schema_report-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vcti_usd_schema_report-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for vcti_usd_schema_report-0.1.0-py3-none-any.whl |
Total release size: 72.6 kB
Release files / vcti_usd_schema_report-0.1.0.tar.gz
| Download URL | vcti_usd_schema_report-0.1.0.tar.gz |
|---|---|
| Size | 43.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fc9742413458b686945b0cd7c467159f8a7f535bb400511a2f4bad6ac0087241
|
|
BLAKE2b-256 checksum How to use checksums |
20a50c75946c746bf0a1264fc332a04a568d66dff69f1971d9ac0d2b508e8692
|
| 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 Nov 14, 2026.
Transparency logRelease files / vcti_usd_schema_report-0.1.0-py3-none-any.whl
| Download URL | vcti_usd_schema_report-0.1.0-py3-none-any.whl |
|---|---|
| Size | 29.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58f9f798bfb70dcf1dfc8177f5f89e19eabad91ea84ac3f47d2e02db95bdab1d
|
|
BLAKE2b-256 checksum How to use checksums |
0a430b5dfb8f5ded0337a320d52b8f5c3aaa69239e43cff5f95f87663ffc65af
|
| 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 Nov 14, 2026.
Transparency logSecurity for vcti-usd-schema-report 0.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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for vcti_usd_schema_report-0.1.0.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 Nov 14, 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.