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

This version

2.2.4

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.4.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.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.4.tar.gz
Algorithm Hash digest
SHA256 3204267e201789d66c034777be9414255cbd955596c44837c0f0bf71e7b31b00
MD5 ff4919b1724c1f42e7b605bed239182a
BLAKE2b-256 0478ad55e497e70e649ec89e0d884248a28f77317d5913427ba5454337856106

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2d8e883861645f91651fb757ea0714d91db1d66e058cc8b1db2fb8375b028d97
MD5 7e5e559166ebdde9bbc8dcd12767a898
BLAKE2b-256 4e3dfac539f5deb55c261790a9ef7d8958216df02486c866669c85795403c17a

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