Skip to main content

A protocol and tools for defining and working with criteria sets

Project description

Openframe ApS

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
TaskItemValue The raw value of a TaskItem, which can be an array
TaskItemScalarValue The raw value of a TaskItem
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

Deploy using the following commands:

python3 -m build
python3 -m twine upload dist/*

License

Openframe Criteria Set Protocol by Openframe ApS is licensed under CC BY-ND 4.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openframe_criteria_set_protocol-2.0.11.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file openframe_criteria_set_protocol-2.0.11.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.11.tar.gz
Algorithm Hash digest
SHA256 e8c3f157e0ad8b8b07943c3f70c0c1f6fa8b298a614c8a2a384fa5d1d422c78a
MD5 bc9bb6ccb53814dbd84b486365239b26
BLAKE2b-256 28bdcc44ce8089e93ef9e9817bfc2f609791346c3625c2fea8b0129f5c7c1728

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 d0e9a2e174976986d6a77bbec720b432e58d08ad16fb635bcb2fba0b3bfb1993
MD5 f808fa752bd4d10b455ce275e03a72a3
BLAKE2b-256 f7c8562da2f20992f1138705789022accda7350d5811c80931a16ea3168f6a9d

See more details on using hashes here.

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