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.8.0a1.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.

File details

Details for the file openframe_criteria_set_protocol-2.8.0a1.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.8.0a1.tar.gz
Algorithm Hash digest
SHA256 15df214d0efe5cf8c6510bf9b9b6d649266a9c0409721b188df16c3eea8fa253
MD5 083418d4ee71573d761ac2d1c5a4d3c4
BLAKE2b-256 625dc7122706031b5474580b1b011858872bec3105868ef587190db397eb120f

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.8.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.8.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 35f607a4efea085d0538c44cd26e51da7a9126ee2bc07ba7a3e386733d2e1bbd
MD5 9ed8915e09cfcd782c25de29e03d6931
BLAKE2b-256 ff6d79079a32e8c3eef0119f147abd74c899e2d88404ed439610b629f2d4956e

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