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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.7.tar.gz
Algorithm Hash digest
SHA256 6efd0bd3640930d3f1c9ba53215c2f9f4fb84db777d589ae02174efed9239038
MD5 1b7ce9a75b48e80d3d0e5e8290c1e45a
BLAKE2b-256 6333c941cc692bd64e7db4fd0fbe1bfe9fabee7772f2c5113b8d99d2544ac4ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0419e2db3737440b553ee21750b863ebf1adb9a0d8af6ff920477b64e58e1b01
MD5 18c651f8506c2eb5c17788566bd7be96
BLAKE2b-256 78330a841e20eb86b31c021d19e77f714a0e84eb474284f927e7c2a877d390c0

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