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
TaskItemValueReference The raw value reference of a TaskItem
TaskItemValueReferenceMap A map of TaskItem value references
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.2a3.tar.gz (17.0 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.7.2a3.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.2a3.tar.gz
Algorithm Hash digest
SHA256 7c3deb150c95ff5512b2ee87b208d8254ed2a92ef799c1a2cee12d6017058750
MD5 96ae4872c82fee4cc4bab0bbbe46cd68
BLAKE2b-256 963d46d59389ed522ffd36e4e2c313028e5f9f051f7576ebf9252bdb7e230b28

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.7.2a3-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.2a3-py3-none-any.whl
Algorithm Hash digest
SHA256 39b5121eede82b863e85075632fe6521d72c350c9455ec19e465ea833fb98f1e
MD5 dd541f2f18b6644409a6fb059746e85b
BLAKE2b-256 54066d2add6e4ebcb84907b96f1e5150e79885cbb47dc5fb72a03607dcdeb408

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