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.5.0a1.tar.gz (16.4 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.5.0a1.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.5.0a1.tar.gz
Algorithm Hash digest
SHA256 46855d134bd99553c885d7847377deacfe6a9fed237b74ef36ff9bac897fc0b5
MD5 b4c0aa0c816116a93db45f8325672b22
BLAKE2b-256 dc9ac5ab402e4df4339281ced07177f4f73c667103d61d270a75a1a0905d6880

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.5.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 38404aa35c7752e7fcd1d41e438ed246bd8e03f84746a93907a9ebd5af5c1313
MD5 3c0dde6b6828943400fa5b7678428175
BLAKE2b-256 6f4005140499b742c577df9f2dd28f439bab47a3ce8587b478d39a7927a17f10

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