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.10.tar.gz (15.7 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.10.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.10.tar.gz
Algorithm Hash digest
SHA256 e44c2dc097a58b0a5138351a18a209625186f3c0d99b157d4b9ea46a74d694e1
MD5 efe5f08c8fad3c6f7b675af06f68bd5c
BLAKE2b-256 42eceb00f589cd0d8bb7c775fcfb4388ccae6bb782830c5cdc5c3226e2ee182b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 d13c65e7716dbca53db3732752e31d8f7c97542f3cf7a3e781a838d79fef9a87
MD5 3d9d78ff256d748fcc8d634306a4db16
BLAKE2b-256 136a9e0e788515f7c7eb606ace644e55d52308c9ac9e27e50b913ec87a0ce4f9

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