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

This version

2.6.5

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.6.5.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.5.tar.gz
Algorithm Hash digest
SHA256 052975aef0c5d2a54551026fe2a252ee28fdcf68cd7adc66f562ca06969bf340
MD5 efd22655b3668b56a58835a3417798ea
BLAKE2b-256 dd73b22a0485f8fa94aef25f84df12d8cf6f7dc561b7734b6807574c1090c5b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 aa23c969f5ec853eb19481043fda39945880e8e6b2de02e1a0fce15a3e1bf0ac
MD5 fc2e23fd563d5df1a39edc7d150c8418
BLAKE2b-256 8ff786a1622b7ce8af6ace22ec1ae63ff4224597df07e35141aa18d2dc731118

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