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.6.0a8.tar.gz (16.5 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.6.0a8.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.0a8.tar.gz
Algorithm Hash digest
SHA256 52f1e78a8106c55c543167476e5e60571f7bc9d7bf8a431991bbef1f7700d5f1
MD5 0e996acb5c0b6976bf949df494e019ce
BLAKE2b-256 eb7f3613914516ab58ecc1b59f75d950446e3075fe763a6c86cc4c3398866cf9

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.6.0a8-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 a671a5fc2fb53d239f3a0042777b288763dbf783f4d2825fef60ca7181b7a18d
MD5 959ec5eeae3eb1a1a8a22d26f6a989e8
BLAKE2b-256 84006de48f918190f5a26db3a132628736a9963bd6af5085b062bc510cb826a6

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