Standard Transcription JSON (STJ) Format

Version: 0.6 Date: 2024-10-27

Introduction

The Standard Transcription JSON (STJ) format is a proposed standard for representing transcribed audio and video data in a structured, machine-readable JSON format. It aims to provide a comprehensive and flexible framework that is a superset of existing transcription and subtitle formats.

Read the full specification

Repository Structure

/spec: The STJ format specification and schemas.
/examples: Sample STJ files demonstrating various features.
/tools: Scripts and libraries for working with STJ files.
/docs: Documentation and guides.
/tests: Unit tests for tools and validators.
/integrations: Examples of integrating STJ with other services.
/benchmarks: Performance benchmarking scripts.
/.github: GitHub configuration files.

Getting Started

To get started with STJ, please refer to the Getting Started Guide.

Installation

Python Tools

Before running the Python tools, install the required packages. It's recommended to use a virtual environment.

Using a Virtual Environment:

# Navigate to the tools/python/ directory
cd tools/python/

# Create a virtual environment
python3 -m venv venv

# Activate the virtual environment
# On macOS/Linux:
source venv/bin/activate

# On Windows:
venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

Without a Virtual Environment:

pip install -r tools/python/requirements.txt

JavaScript Tools

Before running the JavaScript tools, install the required packages using npm.

# Navigate to the tools/javascript/ directory
cd tools/javascript/

# Install dependencies
npm install

For more detailed installation instructions and troubleshooting, please refer to the Installation Guide.

Running Tests

Python Tests

To run the Python tests:

cd tests/python/
pytest

JavaScript Tests

To run the JavaScript tests:

# Navigate to the JavaScript tools directory
cd tools/javascript/

# Install dependencies (if not already installed)
npm install

# Run tests
npm test

Continuous Integration

The repository uses GitHub Actions for continuous integration. Tests are automatically run on every push and pull request. The CI pipeline runs both Python and JavaScript tests in parallel.

Contributing

Contributions are welcome! Please read our Contribution Guidelines and Code of Conduct.

yaniv-golan/STJ