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.0.14.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.14.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.14.tar.gz
Algorithm Hash digest
SHA256 4041116009edd6008b326f709852a20800e11da79ae248c208acfc3e3f7f682d
MD5 29ca894efea4a7a44a0da1a477370034
BLAKE2b-256 4b6318a079196fc7f7cbf6b5230c2310d07ecc6cfa8c8d2551f7d161178a45aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 5f67a1fc80866e933846ac911274aadf32dd626f58ef18eece1391df824c0165
MD5 ccc56add98be2fdad188420bd14800df
BLAKE2b-256 0ae35e83013340969554a4f4c4f4b54e4952a1437e7f08d1c65f2d8f4c41ddce

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