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.3.tar.gz (16.4 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.3-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.3.tar.gz
Algorithm Hash digest
SHA256 03af787fc734b2c8fadd08b81a7761e90611bb6ef7730705c2d10fb61759066f
MD5 52fd043c7a4fe538782c919ce1038a6d
BLAKE2b-256 497a6f91c964ffb6cdd4a3aeb1bd94cce02175b479196df9f2fac909b8483fdf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3e093f46b6f3b372fcf0dd1120b2cb2dc8114ad7e3c26c069044c1ef9293f35e
MD5 263db8c1257bb5e6dc664f30e115b990
BLAKE2b-256 163d345df859bc1b8c03f993d5e858bf61b26abd8ee9af803939be3a169c1cda

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