Audify

Getting Started

  • Installation
    • Requirements
      • Optional
    • Install from PyPI
    • Install from Source
      • Development dependencies
    • Verify Installation
    • Docker Setup (Optional)
      • Pull an Ollama model
  • Quick Start
    • Option 1: Cloud TTS (Easiest)
      • 1. Install Audify
      • 2. Configure credentials
      • 3. Convert a book
    • Option 2: Kokoro TTS (Local, Free)
      • 1. Clone and start services
      • 2. Pull an Ollama model
      • 3. Convert a book
    • Option 3: Qwen-TTS (Local, Free)
      • 1. Start Qwen-TTS
      • 2. Install and configure Audify
      • 3. Convert a book
    • Next Steps

User Guide

  • Usage
    • Basic TTS Conversion
      • Understanding –language and –translate
    • LLM-Powered Audiobook Generation
      • Using commercial LLM APIs
    • Task System
    • Directory Processing
    • Unified Convert Command
    • Listing Available Options
    • Output Structure
      • Basic TTS (audify run)
      • LLM Audiobook (audify audiobook)
  • Task System
    • Built-in Tasks
      • List tasks
      • Use a built-in task
    • Custom Prompt Files
      • Validate a prompt file
    • Writing Effective Prompts
      • Example: Children’s story prompt
      • Example: News briefing prompt
    • Programmatic Task Registration
  • Configuration
    • The .keys File
    • TTS Provider Comparison
    • Google Cloud TTS Configuration
    • Docker Services
    • Supported Languages
  • REST API
    • Starting the API
    • Endpoints
    • Examples
      • Synthesize an EPUB to MP3
      • Create an M4B audiobook
      • List available providers
      • List voices for a provider

Reference

  • CLI Reference
    • Global
    • audify run
      • Arguments
      • Options
    • audify audiobook
      • Arguments
      • Options
    • audify convert
    • audify list-tasks
    • audify validate-prompt
  • Architecture
    • Overview
    • Pipeline
      • Readers (audify/readers/)
      • Task System (audify/prompts/)
      • AudiobookCreator (audify/audiobook_creator.py)
      • Synthesizers (audify/text_to_speech.py)
      • Audio Processing (audify/utils/)
    • External Services
  • Using Commercial APIs with Audify
    • Supported APIs
    • Setup
      • 1. Create a .keys File
      • 2. Get API Keys
    • Usage
      • DeepSeek Examples
      • Claude Examples
      • OpenAI Examples
      • Google Gemini Examples
    • Complete Example
    • Comparing Ollama vs Commercial APIs
    • Model Recommendations
      • For Best Quality
      • For Best Value
      • For Reasoning Tasks
    • Troubleshooting
      • API Key Not Found
      • Connection Error
      • Invalid Model Name
    • Environment Variables (Alternative to .keys file)
    • Cost Considerations
    • Technical Details

Development

  • Contributing
    • Development Setup
    • Development Workflow
      • 1. Create a branch
      • 2. Make changes
      • 3. Run checks
      • 4. Submit a PR
    • Task Commands
    • Code Quality
    • Project Structure
  • Changelog
    • [Unreleased]
      • Added
      • Changed
    • [0.1.0] - 2024-01-01
      • Added
Audify
  • Search

© Copyright 2024, Audify Contributors.

Built with Sphinx using a theme provided by Read the Docs.