OpenUI Specification
This repository contains a technology-independent specification for a Web UI framework. It also includes an Angular TypeScript generator that applies a UI description authored against the spec to an existing Angular workspace. The goal is to use the specification as the basis for a standard.
- Using the specification — read the published docs on ReadTheDocs: https://openui-spec.readthedocs.io/
Developer docs
Contributor and developer entry points for this repository:
- Contributing guide — local setup and validation basics.
OpenUI JSON API
The bin package provides OpenUiJson for loading, validating, and editing an
OpenUI JSON document. Validation checks both spec/openui.schema.json and the
object types supported by the canonical spec/openui.json catalog. The published
OpenUI JSON editing
tooling page documents these commands for spec users.
Use the CLI to validate or apply one change in place (pass --output to write
to a different file):
python bin/openui_json_cli.py validate --input spec/openui.json
python bin/openui_json_cli.py add --input document.json --parent root --object '{"id":"newTable","type":"Table"}'
python bin/openui_json_cli.py remove --input document.json --id newTable
python bin/openui_json_cli.py modify --input document.json --id table --attrs '{"title":"Updated"}'
python bin/openui_json_cli.py modify --input document.json --id table --object '{"id":"table","type":"Grid"}'
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openui_spec-0.0.1.tar.gz.
File metadata
- Download URL: openui_spec-0.0.1.tar.gz
- Upload date:
- Size: 79.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d75f8f132b304003e97a62262449e03e71ee03ccf4ca50b4f95985e67018af7
|
|
| MD5 |
36d44b6b62ab539b6d676ef466e2097e
|
|
| BLAKE2b-256 |
ad48866ae3920b67b3c20ba35bd69916cd3ed9afa075cab83f361877ca94fb37
|
Provenance
The following attestation bundles were made for openui_spec-0.0.1.tar.gz:
Publisher:
publish.yml on shlomoa/openui-spec
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
openui_spec-0.0.1.tar.gz -
Subject digest:
6d75f8f132b304003e97a62262449e03e71ee03ccf4ca50b4f95985e67018af7 - Sigstore transparency entry: 2326664130
- Sigstore integration time:
-
Permalink:
shlomoa/openui-spec@c45cc56e4cf193f6199236441e393c8bc47f86d6 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/shlomoa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c45cc56e4cf193f6199236441e393c8bc47f86d6 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file openui_spec-0.0.1-py3-none-any.whl.
File metadata
- Download URL: openui_spec-0.0.1-py3-none-any.whl
- Upload date:
- Size: 95.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b8490b9323e833f5e9ac2cff15210a639f6a1c789e64c74bc3d0e5b4d0816dc
|
|
| MD5 |
ad8b71ae358a0c01c23771551141e159
|
|
| BLAKE2b-256 |
335e7fb86da8b978cd4d8a411a02ce1c99074f507ad3a4e95b363c9911d936b4
|
Provenance
The following attestation bundles were made for openui_spec-0.0.1-py3-none-any.whl:
Publisher:
publish.yml on shlomoa/openui-spec
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
openui_spec-0.0.1-py3-none-any.whl -
Subject digest:
7b8490b9323e833f5e9ac2cff15210a639f6a1c789e64c74bc3d0e5b4d0816dc - Sigstore transparency entry: 2326664547
- Sigstore integration time:
-
Permalink:
shlomoa/openui-spec@c45cc56e4cf193f6199236441e393c8bc47f86d6 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/shlomoa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c45cc56e4cf193f6199236441e393c8bc47f86d6 -
Trigger Event:
workflow_dispatch
-
Statement type:
