stjlib 0.1.0

A Python wrapper for the Standard Transcription JSON (STJ) format.

STJLib

A Python library for the Standard Transcription JSON (STJ) format.

Overview

STJLib provides data classes and utilities for working with STJ files, which are used to represent transcribed audio and video data in a structured, machine-readable JSON format.

For more information about the STJ format, please refer to the STJ Specification.

Documentation

Full documentation is available at stjlib.readthedocs.io. This includes:

• Detailed API reference
• Usage examples
• Advanced usage guides
• Contributing guidelines

Features

• Load and save STJ files
• Validate STJ data according to the specification
• Access and manipulate metadata and transcript data
• Flexible error handling and validation reporting

Quick Start

Installation

pip install stjlib

Basic Usage

from stjlib import StandardTranscriptionJSON

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

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

# Save modified data back to a file
stj.to_file('path/to/output.stj.json')

For more examples and detailed usage instructions, please refer to our documentation.

Development

Setting Up Development Environment

# Clone the repository
git clone https://github.com/yourusername/stjlib.git
cd stjlib

# Install development dependencies
pip install -e .
pip install -r requirements-dev.txt

Running Tests

pytest

Building Documentation Locally

cd docs
make html

The documentation will be available in docs/build/html.

Contributing

Contributions are welcome! Please follow these steps:

1. Check for open issues or open a new issue to start a discussion
2. Fork the repository and create a new branch: git checkout -b feature/your-feature-name
3. Write your code and tests
4. Ensure all tests pass: pytest
5. Submit a Pull Request

For more detailed guidelines, see our Contributing Guide.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

• For bugs and feature requests, please open an issue
• For other questions, start a GitHub Discussion