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.6.0.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.

openframe_criteria_set_protocol-2.6.0-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.0.tar.gz
Algorithm Hash digest
SHA256 141527d2dd2054545519607e20b9e7de30571ec0a3d6314d3010c4b58956b56d
MD5 fa46316bf930c2ec7adb409895e61d93
BLAKE2b-256 58529ec0781426be640538042cc1d0a09978291136efad714e9097648fedc07e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c780e84558ef134c48d6845d4ad519e0a656cd3679b4705980dc068bdaa94fa6
MD5 f79f062349111d21f6d2593e38d3d803
BLAKE2b-256 9485e3e37ab451b6560438a7a5b1f8b728466afa643a0071b59a81c4d92a0be7

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