Tools Overview

OpenReason Protocol provides three ways to validate and work with ORP documents:

1. Command-Line Interface (CLI)

Best for: Local development, shell scripts, CI/CD pipelines

pip install orp-validator
orp validate my-document.yaml

Features:

• Create new documents with interactive prompts
• Validate against JSON Schema
• Check compliance levels quickly
• Compare documents (diff)
• Offline operation

Full CLI Documentation →

2. Python API

Best for: Integration into Python applications, automated workflows

from orp_validator import validate
 
result = validate("my-document.yaml")
print(f"Valid: {result.valid}")
print(f"Compliance: {result.compliance_level}")

Features:

• Programmatic validation
• Integration with data pipelines
• Custom error handling
• Batch processing

Full Python API Documentation →

3. REST API

Best for: Web applications, cross-platform integration, browser-based tools

curl -X POST https://api.publicreasonproject.org/api/v1/validate \
  -H "Content-Type: application/json" \
  -d '{"document": "orp_version: \"0.1\"\n..."}'

Features:

• No installation required
• Language-agnostic
• Three endpoints: validate, check, diff
• 60 requests/minute rate limit

Full REST API Documentation →

Which Tool Should I Use?

Installation

CLI & Python API

pip install orp-validator

Requires Python 3.9+. See Installation Guide for details.

REST API

No installation required. Available at:

• Base URL: https://api.publicreasonproject.org
• Documentation: https://api.publicreasonproject.org/docs

Version Compatibility

All tools validate against ORP v0.1 specification.

Next Steps

• CLI Reference - All commands and options
• Python API - Integration guide
• REST API - HTTP endpoints
• Quick Start - Get up and running in 60 seconds