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.6.2.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

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

openframe_criteria_set_protocol-2.6.2-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.2.tar.gz
Algorithm Hash digest
SHA256 b79f2bf162a05034f97ec6ac5822de8024d40ce70b0fb35327a1220b8c368a84
MD5 3c84f8f3b1ddc434ac6cc5d64ed6d339
BLAKE2b-256 ec2abfd85f4201e88f2eaba4964b832927f37c9192240e27cca722ec0a312363

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 55248f7911762a1dcc19739110cb9f504848523eab700e973ac2ddd982f1e3a7
MD5 6b1a31d86584b44e6c1d549d9d3d46d3
BLAKE2b-256 ebad5b30e755b35c357e58a0e4205d5fbbd3aeead8cd8e4d4b6f136741caed81

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