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.1.10.tar.gz (16.2 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.1.10.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.10.tar.gz
Algorithm Hash digest
SHA256 0d1a4be67cc08dd57e077659f6743efb6387d35a57c9d3cfdc23787397d5dd94
MD5 3cddb01dfa640aa444c9f338e35dea92
BLAKE2b-256 d9a62ff5d329fab905ca920d13e541ef9024a316f6306081ae508e18f5e74baa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 51741b05869d0e094b5799314b70d753c016a4977bbf14064804f2cec01912d5
MD5 c4bb7115c9f8c11e39c83e4d0f2f8d46
BLAKE2b-256 39e71365f19492ee9b791e2471a74bb7db8bf768994d2137bd84afb10bedbcf6

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