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.13.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.1.13.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.13.tar.gz
Algorithm Hash digest
SHA256 7a131510730925704a228888cfedf793d5c210b90f4642f572d798a4a6c79a17
MD5 82a1da1a1f08ab311797382311de0429
BLAKE2b-256 e978d0d799b433b80151bebc20eb9c241a809d027ede4b05a98a1bdcdb3aacc5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 aef8575631a8d15bc745f71f1a9b7b17f3f074a938b94527b8f5b257bf1c4f8b
MD5 eb9034ea01e4db509f2025a188738c0a
BLAKE2b-256 8e9d2cb5cb2fb72ec3e8c121f7e519d5349eec52d67287feba4c8708e790485e

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