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
TaskItemValueReference The raw value reference of a TaskItem
TaskItemValueReferenceMap A map of TaskItem value references
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.7.2a0.tar.gz (17.0 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.7.2a0.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.2a0.tar.gz
Algorithm Hash digest
SHA256 375e452df996a5b637b3ba2dc7f0424dca57adb52768d52a0abc0f0edef57888
MD5 cbfc0e1531af8ed6bbd1161e9ece7ca3
BLAKE2b-256 97388ac2a39848d3a2554fb4c1d604f57c9629f6ef62cc7f99a78ddeb3445590

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.7.2a0-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.7.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ca92b839e81a5dca78cd99cae69fc1b9ba6433c7adbd4e06ac83d8f27cc09c3
MD5 37ec693f0ab18581e4f27af63e4ddd84
BLAKE2b-256 7f9788a2299cf06167cfcedcba0f2a107f753d8b9506f48ef86786c26b1b6bad

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