Welcome to STJLib’s Documentation

STJLib is a Python library for working with Standard Transcription JSON (STJ) format files.

Contents:

• Installation
  • Requirements
  • File Format Support
  • Installing from PyPI
  • Installing from Source
• Usage Guide
  • Basic Usage
• API Reference
  • StandardTranscriptionJSON
  • Data Classes
  • Enumerations
  • Exceptions
• Advanced Usage
  • Custom Validation
  • Working with Additional Info
• STJLib Modules

Features

• Load and save STJ files

• Validate STJ data according to specification

• Access and manipulate metadata and transcript data

• Flexible error handling and validation reporting

Quick Start

Install STJLib:

pip install stjlib

Basic usage:

from stjlib import StandardTranscriptionJSON

# Load an STJ file
stj = StandardTranscriptionJSON.from_file('path/to/file.stj.json')

# Access metadata and transcript
print(stj.metadata)
print(stj.transcript)

For more detailed information, check out the Usage Guide guide.