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.0.tar.gz (16.3 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.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.0.tar.gz
Algorithm Hash digest
SHA256 71033522f6e90f84f4577e723245b8e4403c2a9b294b00d2ed940c36ee2e7a4c
MD5 714fa22c48fea07e7e5c0e66d3b0bac7
BLAKE2b-256 8fea91142271b61be8f0f06df159216121d2cf21f07c4f643066dfeb86972390

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a7ed28e3ebc2a9806b4679e08a09252ded586e49ac797db7b334b0cad23546b2
MD5 074cd5e7d636ae0ace6768e2110c78ce
BLAKE2b-256 8f5451c81a6fbda16719b23df6339179ea50bd64a3b7d88895dcaa906ac3445a

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