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

openframe_criteria_set_protocol-2.1.2-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.2.tar.gz
Algorithm Hash digest
SHA256 878e046aa683974cb9ad3b20b688a2be3de17112af2204a557e5f317c6fa22a0
MD5 eb6ad1547b2a31c342c30ccc67b52f51
BLAKE2b-256 83ddc0a970dbc3258162377d5019eb2728aa0518b0a4ab3143920dfaab898af4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 343de97b638159524da8e3bb6a161b25d8aae01ad1d26aeef2945b2c3ff2f9cb
MD5 f7ebfef1732273d306a6ddf668c79292
BLAKE2b-256 6e47b82fc16e99a63fe9a8b4baf09e5f980f144a82dd21a6e689fd2fc4c0a517

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