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.8.0a0.tar.gz (16.2 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.8.0a0.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.8.0a0.tar.gz
Algorithm Hash digest
SHA256 620643dde6ef384ee34fdff72beb03c607344741b802ee451a45a6004e5e684b
MD5 cff65441f54328561974065a2fc852d5
BLAKE2b-256 03861aa8279a9d77c447b0022419cafbd0bb77696cf97da9663754a11154333c

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.8.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.8.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 989f1b71308ed58a95f995460f57d8b3a712428387c368014f96bce487e2a0d9
MD5 c27ea0b93ce3ff6bbdc38fcb8abc3a96
BLAKE2b-256 4003fb01031cbd3735ba62b83ef0b1cd72364a8601a989a542e8b9e8895db13a

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