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

openframe_criteria_set_protocol-2.1.7-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.7.tar.gz
Algorithm Hash digest
SHA256 6dd41f0d374d9aed9d1ff8ca798a00ea663bae5865e00ad4e7ffca418683d2fe
MD5 d77200eb167d2570c97cbda1fa43bc52
BLAKE2b-256 0d2a457231063ff88b7ed4c3e29e5a224bb672ffeb3e807b572ca8156aa5e8f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7888c5e046c284ea654e55bb40df5cbf612eef1bddc98d4e917da46a47e1222a
MD5 caef616bea3355cebe1bb349a675dce3
BLAKE2b-256 60c4417ee1876f28c31b820e0e5a904e741e9a8dc7c93482e09642a8d8abc0f1

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