Skip to main content

A protocol and tools for defining and working with criteria sets

Project description

Frame 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

This version

2.0.9

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.0.9.tar.gz (15.8 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.0.9.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.9.tar.gz
Algorithm Hash digest
SHA256 393906c878566c5a079ef77dc7b04512acdfaff6c7898c87222f1ff321d5a2b5
MD5 5702278ceeeb7759fda275c2938540ce
BLAKE2b-256 a7c4613e3d0cc6e8be1d8091e27516c402789827975f4eb5c9e8c0d5255bcd0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 cc2de7981090fd22896de1240dce4aeee7a96a5bcc8468d4c709dec81be658c6
MD5 ba3221aedc7c2372ca61c00af06cc123
BLAKE2b-256 c2c5e6e67ee7f31e7adec0b816b8760fa81f1bebc4b85b9babf5e060a95c4a88

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