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

This version

2.6.3

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.6.3.tar.gz (16.5 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.6.3.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.3.tar.gz
Algorithm Hash digest
SHA256 d55462728959088d96bd66a5bc1aec1e5dacf7d5fcbe88202f7c49165b78b204
MD5 c274d93616552f96aacbb865640c268c
BLAKE2b-256 c1ea6f632f2f2591ed163f9761231ff1260ef5d849ffc8b019bec85bdfc412fb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6c58a68112f28794fc0062ed80c55cfbfaf2e7f6aa6dcd38f77853dd42158f36
MD5 a3ac203ade50bcc4dc2d3510dbd1dda6
BLAKE2b-256 4b30badd3eccd4b03f422065ea6444362a38012611053f7e86601e8311fbcfe4

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