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
TaskItemValueReference The raw value reference of a TaskItem
TaskItemValueReferenceMap A map of TaskItem value references
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.10.0.tar.gz (16.8 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.10.0.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.10.0.tar.gz
Algorithm Hash digest
SHA256 802fe9cacaa753c0922ab29f3f3ae530097c088e55759dda219909af4f737f6e
MD5 86b150c25747648f7f3dc7196adb6b46
BLAKE2b-256 8f81c2007eac4a9e0a65b1950e8ddf049a7854d81d10e558a461df06de1c66f7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3eccea0fdaf96b037d4cfd8a455ae7c2af598fd42f5fd758bb59ed6b4ffc282d
MD5 9d6bb2113202b3d8ae52b0d84ba3f029
BLAKE2b-256 11dcd63b553445ffe84cafb110bad081859c8069583f89149cff393efec286cc

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