Criteria Set Protocol
Python library
This is a Python library with types and implementations of the Criteria Set Protocol. It is published
publicly on PyPI as openframe-criteria-set-protocol.
Installation
pip install openframe-criteria-set-protocol
Contents
Protocol v1
The library contains the types defined in the protocol v1 specification.
Types
| Type | Remarks |
|---|---|
| Metadata types | |
Metadata |
|
Theme |
|
ThemeStyle |
|
Color |
|
RgbColor |
|
| Task tree types | |
CriteriaTree |
|
Criterion |
|
TaskGroup |
|
Task |
|
TaskItem |
|
| TaskItem value types | |
SelectSingleType |
|
SelectMultipleType |
|
NumberType |
|
BooleanType |
|
PointOption |
Used by SelectSingleType and SelectMultipleType |
TaskItemValueReference |
The raw value reference of a TaskItem |
TaskItemValueReferenceMap |
A map of TaskItem value references |
| REST types | |
MetadataResponse |
Metadata endpoint response body |
StreamCriteriaSetMatrixBody |
Request body for the matrix streaming endpoints |
StreamMatrixResponse |
Matrix streaming endpoints response body |
Schemas
Validation schemas are provided for validating the endpoints of the protocol v1 specification.
| Schema | Remarks |
|---|---|
criteria_set_id |
Regular expression for the criteria_set_id parameter for endpoints which use it |
version |
Regular expression for the version parameter for endpoints which use it |
| marshmallow schemas | |
TreeAndMatrixBodySchema |
Schema for validating the request body for tree and matrix endpoints |
Deployment
Publish a stable GitHub release tagged python/vX.Y.Z, matching the version in
pyproject.toml. The release workflow tests, builds, and publishes this package
to PyPI using trusted publishing. The TypeScript package is not published.
Both libraries must have stable versions with matching major/minor components; patch versions may differ. See Package releases for the version policy and registry setup.
License
Openframe Criteria Set Protocol by Openframe ApS is licensed under CC BY-ND 4.0
1 maintainer
Metadata
1 maintainer
Release files for openframe-criteria-set-protocol 2.11.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 |
|---|---|---|---|---|
| openframe_criteria_set_protocol-2.11.1.tar.gz | 17.5 kB | With provenance | Details for openframe_criteria_set_protocol-2.11.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| openframe_criteria_set_protocol-2.11.1-py3-none-any.whl | Python 3 | none | any | Details for openframe_criteria_set_protocol-2.11.1-py3-none-any.whl |
Total release size: 35.9 kB
Release files / openframe_criteria_set_protocol-2.11.1.tar.gz
| Download URL | openframe_criteria_set_protocol-2.11.1.tar.gz |
|---|---|
| Size | 17.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a2892eba61e0f0c548b8dd673e83e8a7b055db2d46cf698050633d4e5e6e16bb
|
|
BLAKE2b-256 checksum How to use checksums |
691fae007e5f679508671b5106729233f0be63fc52e071cb7d7e3c24e8d56a78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 21, 2026.
Transparency logRelease files / openframe_criteria_set_protocol-2.11.1-py3-none-any.whl
| Download URL | openframe_criteria_set_protocol-2.11.1-py3-none-any.whl |
|---|---|
| Size | 18.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9352324c97c4d8a93befefe3eff904b69c28d7221b3b513bcbc98d2a4a2f6162
|
|
BLAKE2b-256 checksum How to use checksums |
f4ee57c252715419508dc8044736c880a9f23db3a88cd0beaf2efc20ed604873
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 21, 2026.
Transparency logSecurity for openframe-criteria-set-protocol 2.11.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 openframe_criteria_set_protocol-2.11.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 Sep 21, 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.
