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
TaskItemValueReference The raw value reference of a TaskItem
TaskItemValueReferenceMap A map of TaskItem value references
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.7.2a4.tar.gz (17.0 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.7.2a4.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.2a4.tar.gz
Algorithm Hash digest
SHA256 f4fce94fb2f6f96c5fdd61d92971abdf50f3ac5e1dcc4ef77ed06d85d0c5aecc
MD5 5839dd95297773818c2c3f5bbef91806
BLAKE2b-256 5f5360f8f09cfff19d224bb9e8ccb21aa23e2fe4adc268eb7f84c521f611c782

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.7.2a4-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.2a4-py3-none-any.whl
Algorithm Hash digest
SHA256 30243143c49f756e46935aaccd9a968cb51bceea8e030bb6744476b51bcc4a55
MD5 e8530f2363d1b7869f4618f944c617ac
BLAKE2b-256 d05de56244c6220f7292eeded02a0ef41366e8efadb3696ef802ca6d577123a3

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