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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.9.tar.gz
Algorithm Hash digest
SHA256 c07c9befedae074497bde94303a468d4cc6e0e801c1016bbf1c9c5821da49fec
MD5 f53ad8a812c0130d7e14d1b0bdee51f8
BLAKE2b-256 16d7de99a1e74bd0f8a398bba05a5630ee360c2319037cba5682213450a6d535

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 58664f68449f4175857d52c670c35b1651b4c597b10b255873326677a46db0e6
MD5 186dd3613d9481ed8ba8f4a290acd2a7
BLAKE2b-256 3c4e194e5746833c421bb89e5151161f174fa357073dc2b24877bbed58838bd6

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