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

This version

2.3.0

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

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.3.0.tar.gz
Algorithm Hash digest
SHA256 20497162b64de3039968dfd370d2fd05d52c4975ae496b4ae1134c9a41ff8507
MD5 9abd8a26cce3f99d4226b626bfad2de9
BLAKE2b-256 b44afbea77c5cc922188f95042cc60ceee06093b0de52c644d2aeb07029fc41e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6b8d2af0c53646c2d81ceea2f6554117ae256630410dd0ac69405ec6db5c0d4
MD5 8186deda0c93eadad32d09ca9e60743d
BLAKE2b-256 d2fda8dde7f7c30196f63f55942b3294f5c0289b2461d81ed8c68fb0bb50ed4f

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