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.1.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.1.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.10.1.tar.gz
Algorithm Hash digest
SHA256 61d45893f608178554867aeb63ae76c330a5d869d55b8c2cc50a2c33af6829be
MD5 00b4b616c532e378352721f79e0fbcc8
BLAKE2b-256 495a1bd5d1f71907fa82c7a1d89e10f5c6770ab20a3b4d3a842c5ae68d84bf74

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c58ef93aa2e5c30993b843c41e9b6e0c0876d41e904dbabb38c40e69d493edaa
MD5 e91e249a487156f5a0fa26ed66b1b62f
BLAKE2b-256 b40614ce1db95c0912535084a58416356cf3695d36a430929e2abae3e996743c

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