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.1.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.1-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.1.tar.gz
Algorithm Hash digest
SHA256 0926d990998aa68fe8176d4a5dfe51e861d0b02776f79a9712b4bad708fb02e9
MD5 e87daf552f95b7dceed313581b677087
BLAKE2b-256 09de147aa38410129113d8d1c9256ef3fee65e50b9d8d1ad4e76df5a88ed3a63

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a465bb5366be298447bb2c55ef6c52e3ec07b9061e73912cca944fdab22231cb
MD5 dea76f8943827689f8f715ca26644765
BLAKE2b-256 850ccb8cdf4d901b146959127b04c9922237569d802ac6cccb0df504021aa5de

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