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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.6.tar.gz
Algorithm Hash digest
SHA256 5722f466b3a6f1b8cb04b92807ae8120c28c5304eee4840e5f424c6b8e6dc611
MD5 4efd3862d731e16a1afcb532bc1d9039
BLAKE2b-256 f6fb1c061cb0fd01d936aff6b73a87d715ad3a8d6259695e54933452baae6e8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5c7c8b96d9fb881c69bd5d4d5c6233527ba047de1e61e89e617d12702bd69cb5
MD5 8352c5ab745ba5185a870399f425afb2
BLAKE2b-256 dc1871bb5dc469d831f495f36528595b14a634a02bdbd1c489fae689206c58af

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