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.1.tar.gz (16.2 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.1-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.1.tar.gz
Algorithm Hash digest
SHA256 900c5676ab96a3a16c731b0c6242e51b45e5a2d4662d38ccd501c1503eeaceed
MD5 e0f19cf6ded522a51a151fe7799db284
BLAKE2b-256 1efd7d49053d8395f2aec6709226abb66fabb2de9858f0f5b38c6d7c71ed73db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 49801c83ac53ec37f312811781b084bb891e7d1efbb592e9cd146da21980f240
MD5 74cac77086fde8404b99d2a973f1ad31
BLAKE2b-256 269595450c19f0b7b457d7e4f977ea855ab3725f3668fb5170fa80906027eb98

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