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.2.6.tar.gz (16.3 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.2.6-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.6.tar.gz
Algorithm Hash digest
SHA256 100760d3bfb34c0444a63640d782d6b577c1e77318da6d6d86eb31c03713509c
MD5 353493d55edd63f2ec51e9997bd8b3d7
BLAKE2b-256 2027f9e07bc2b1ac902a61a604811e452fe2d39f161e76281fad709d320ac466

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4fefaa0c6f7d31cb86f42f8e1a5cd21ed811b6f17b8056ae50ed0d56a9eee5b3
MD5 07db0fe20ce9dfcfeba50e1d3454c263
BLAKE2b-256 0d1c19f631306ff382606bcb23b0e3b4a51d4847663eb57f5018b06c6c540585

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