Skip to main content

A protocol and tools for defining and working with criteria sets

Project description

Frame 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

This version

2.0.8

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.8.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.8.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.8.tar.gz
Algorithm Hash digest
SHA256 c00a9b424d7d91f8f4ea4cd0051fd05c198d77c612cef1f2b807bf4113ca02a2
MD5 19a6244bbd41ee310f94e0e68043c6ef
BLAKE2b-256 9b67e8ecc59dcda05ed3f9883a76ae818de1f96365d7252ee93b4fa80d682a9d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 500d9307add837b193cc7c3b1a2d0a212247ba6465fa8589590cb8928959aa90
MD5 324032944aab88e1e9597d0d39024a39
BLAKE2b-256 e49a5693838b6e323e30c291b71856a10d8c9f8a4f124f4053bd37589b22ef29

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