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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.5.tar.gz
Algorithm Hash digest
SHA256 3c7857e2332d3f542536e68ef1db2057702dc63eead7a5a400e1945cabcc9b11
MD5 edf9d495bd916dfa32f322579c4766a1
BLAKE2b-256 0dd44402e608c02ae360e68f5491d8bec218440c46fd8872da4c3364515061f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f042a8aa41f2936cbc808f888ed42e7229677b03b573f0f0fc484161b703a3c6
MD5 19b36d313483c117e3c8ffebb209d8c9
BLAKE2b-256 3e3c2a2b4955bb2fe57bf9f4adea60c6c1090631ded3bc940880198370d0ef91

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