Installation

vCon WTF can be installed via pip or from source.

Prerequisites

Python 3.10 or higher (3.12 recommended)
pip or uv package manager

Installation Methods

Install from PyPI

The recommended way to install vCon WTF is using pip:

pip install vcon-wtf

Or using uv for faster installation:

uv add vcon-wtf

Install with Optional Dependencies

For integration testing with real API providers:

pip install vcon-wtf[integration]

For development dependencies:

pip install vcon-wtf[dev]

Install from Source

Clone the repository and install in development mode:

git clone https://github.com/vcon-dev/wtf-transcript-converter.git
cd wtf-transcript-converter
pip install -e .

For development with all dependencies:

pip install -e ".[dev,integration]"

Using uv (Recommended)

If you’re using uv for Python package management:

# Clone the repository
git clone https://github.com/vcon-dev/wtf-transcript-converter.git
cd wtf-transcript-converter

# Install in development mode
uv sync --dev

# For integration testing
uv sync --dev --group integration

Verification

Verify the installation by running:

vcon-wtf --help

You should see the help output for the vCon WTF CLI.

Dependencies

Core Dependencies

pydantic - Data validation and settings management
click - Command-line interface creation
rich - Rich text and beautiful formatting
jsonschema - JSON schema validation
python-dateutil - Date/time utilities

Optional Dependencies

Integration Testing

openai - OpenAI API client
deepgram-sdk - Deepgram API client
assemblyai - AssemblyAI API client
rev-ai - Rev.ai API client
transformers - Hugging Face transformers
torch - PyTorch for ML models
datasets - Hugging Face datasets
librosa - Audio processing
soundfile - Audio file I/O
psutil - System monitoring

Development

pytest - Testing framework
pytest-cov - Coverage plugin
black - Code formatting
isort - Import sorting
flake8 - Linting
mypy - Type checking
bandit - Security linting
safety - Dependency vulnerability scanning

Troubleshooting

Common Issues

Import Errors

If you encounter import errors, ensure you’re using the correct Python version:

python --version  # Should be 3.10 or higher

Permission Errors

If you encounter permission errors during installation, try using a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install vcon-wtf

CLI Not Found

If the vcon-wtf command is not found, ensure the package is properly installed:

pip show vcon-wtf
which vcon-wtf  # On Windows: where vcon-wtf

Getting Help

If you encounter issues during installation:

Check the GitHub Issues
Review the troubleshooting section
Join our Discord community
Contact the development team at vcon@ietf.org