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.4.tar.gz (16.8 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.7.4-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.4.tar.gz
Algorithm Hash digest
SHA256 44aac180360dcaf26138712a15bcb80b68cba58105e4479a38628bf149da45da
MD5 1510361dd50c2be5763fcd4ba837d285
BLAKE2b-256 1e55b631399869482e618ac74cb9ee0f9bed3d03e9ca717fcf413b58d9702da0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a5f73e91bb968cfd60a6e615db23ebc4ddf94def472681627c9ffeb5f56a748c
MD5 8e6c4053cf277f8de839041e92b5bc88
BLAKE2b-256 b6316a70c1a674c9e7d6b7598f9f4c51339a72e577fdd62cfcfbdf1fd74d0263

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