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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.1.tar.gz
Algorithm Hash digest
SHA256 468f98658e751e8f51df83d72c011db8741de33922c0f59c866b18907b1d5b5e
MD5 498b3d62e3ef7e38851f504a8d2fb1a2
BLAKE2b-256 cc5134648273661979081fd56b59a3a7dc05eea14f103b5dc01ebd32d1c9b988

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 50806676ed39388c21016b70bde971383004cf011d3b329e2cd79f76c7b90646
MD5 f1b028a8928a7f70c777fda2787e1609
BLAKE2b-256 6e2435946eb071c255477ce95801ef1a524c4ede4b874b1fb3ad7c7c46c0dc02

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