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.0.13.tar.gz (15.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.0.13.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.13.tar.gz
Algorithm Hash digest
SHA256 89e8a5adf3bc1b6607ceef159291d413951faedc6495fd4dba3ff4e1e2ee87e0
MD5 055dbc9587cefbb5bb01ae8e2f001467
BLAKE2b-256 c560e7ec4ac3fd5f85c40d7c030a107395920be6e2491e00acf9727d49411cdf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 ebd534c0c0ab5c412d9e9f6c890289c9c327d6817a4a8e4d2e3253f94a13cae8
MD5 faf411e07e00c978d2cbe90331bd017d
BLAKE2b-256 47e561e54b4420d3435582030bd678be09cb4dbf02f4d2b3d930c6a5c3c276b0

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