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.7.0.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.7.0-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.0.tar.gz
Algorithm Hash digest
SHA256 44eea8b989a2ecb3169144bf56861320df55771ac19cb623f7317de3ae1ece84
MD5 e9d2059983df3ace0e82622686da7487
BLAKE2b-256 360f7e5c48972ddec3f34fd7225762f492621de022674d6ce5788bfed0bf8325

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 df21ee99d28a91529d1a399c88d60ee84428fdbafb462d431d5d1c14e834906c
MD5 5fba0c0b1adfe05e1bed23cbf3080d67
BLAKE2b-256 347f08b1b2e10bacd84441c54f87e3076e18c30fc2daaf7f4bdac228dbd71df5

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