Skip to main content

A protocol and tools for defining and working with criteria sets

Project description

Frame 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.0.7

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.7.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.7.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.7.tar.gz
Algorithm Hash digest
SHA256 d21fa6fa2f8347dbbc7fed6cd11b9f0aa507a2375c9dd9e360ad1ce768ba8960
MD5 85b4e5ffc3f0ed1020c8ef8077ea77de
BLAKE2b-256 8c8f4b7ef345f8d49ae154151115a7048da63218ba17331082efe01d43619552

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bf2ce813f462d189298ac0fc3ef42bdcf4b9dcce5114d08b393dacf1422542fa
MD5 4a3d1cff8bc94c60600286718364f8d0
BLAKE2b-256 893c2b83f99f3054c5067911d3ca7e401607b0f266880f7ec78402f3586bf387

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