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.4.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.4.1-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.4.1.tar.gz
Algorithm Hash digest
SHA256 000cad0e40ff22e2026ec0801f526c50664330b916e495fa7840c89bdbaaf650
MD5 96311bb856c06ce9afcd7b1829c043f3
BLAKE2b-256 507096a50fa2b54fdfb43f0c341efd8e9ad691218183f19902bfed63390a5051

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 48a2301ee4e982d34a18ac2f9a48e1bca260e8f6671b07ff240ef8245bf260b4
MD5 82ad2a79f04666bf8c7d397b0b1f2d9c
BLAKE2b-256 e4630853559597f40b6e454e7aa5e56c541e4c37b4f44c98b7c03d409691bc28

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