abogen
Generate audiobooks from EPUBs, PDFs and text with synchronized captions.
File Explorer
Download Latest Version (.zip)- test_pip.yml
- test_publish.yml
- FUNDING.yml
- __init__.py
- chapter_selection.py
- cleanup.py
- conversion_config.py
- conversion_executor.py
- conversion_models.py
- conversion_planner.py
- conversion_ports.py
- conversion_request.py
- conversion_result.py
- conversion_service.py
- integration_hooks.py
- output_layout_service.py
- voice_resolver.py
- a.png
- b.png
- e.png
- f.png
- h.png
- i.png
- j.png
- p.png
- z.png
- create_shortcuts.bat
- female.png
- icon.ico
- icon.png
- loading.gif
- male.png
- profile.png
- settings.svg
- voice_mixer.png
- audio_buffer.py
- audio_helpers.py
- audio_sink.py
- chapter_classification.py
- chapter_overrides.py
- chapter_titles.py
- chunk_utils.py
- config_types.py
- conversion_engine.py
- conversion_pipeline.py
- device.py
- enums.py
- file_type.py
- intro_outro.py
- metadata_extraction.py
- metadata_helpers.py
- metadata_merge.py
- metadata_overrides.py
- normalization.py
- output_paths.py
- pipeline_factory.py
- progress.py
- pronunciation.py
- settings_core.py
- speaker_metadata.py
- split_pattern.py
- subtitle_generation.py
- subtitle_processor.py
- text_chapters.py
- text_utils.py
- title_builder.py
- tokens.py
- voice_catalog.py
- voice_loader.py
- voice_markers.py
- voice_resolution.py
- voice_utils.py
- __init__.py
- exporter.py
- exporters.py
- subtitle_writer.py
- __init__.py
- audiobookshelf.py
- calibre_opds.py
- libxcb-cursor-amd64.so.0
- libxcb-cursor-arm64.so.0
- __init__.py
- book_handler.py
- conversion.py
- conversion_adapter.py
- gui.py
- main.py
- predownload_gui.py
- queue_manager_gui.py
- queued_item.py
- voice_formula_gui.py
- docopt-0.6.2-py2.py3-none-any.whl
- progress-1.6-py3-none-any.whl
- __init__.py
- capabilities.py
- engine.py
- errors.py
- host_context.py
- loader.py
- manifest.py
- plugin.py
- plugin_manager.py
- types.py
- utils.py
- common.py
- entity.py
- epub.py
- form.py
- service.py
- settings.py
- synthesize.py
- voice.py
- __init__.py
- api.py
- books.py
- entities.py
- jobs.py
- main.py
- settings.py
- voices.py
- settings_service.py
- dashboard.js
- entities.js
- find_books.js
- prepare.js
- queue.js
- reader.js
- settings.js
- speaker-configs.js
- speakers.js
- styles.css
- voices.js
- wizard.js
- jobs.html
- logs.html
- logs_section.html
- logs_section_missing.html
- new_job_step_book.html
- new_job_step_chapters.html
- new_job_step_entities.html
- reader_modal.html
- upload_modal.html
- base.html
- debug_wavs.html
- entities.html
- find_books.html
- index.html
- job_detail.html
- job_logs_missing.html
- job_logs_static.html
- job_not_found.html
- prepare_chapters.html
- prepare_job.html
- prepare_speakers.html
- queue.html
- reader_embed.html
- settings.html
- speakers.html
- voices.html
- __init__.py
- app.py
- conversion_runner.py
- debug_tts_runner.py
- Dockerfile
- entrypoint.sh
- service.py
- book_parser.py
- check_cuda.py
- chunking.py
- constants.py
- debug_tts_samples.py
- entity_analysis.py
- gui.py
- heteronym_overrides.py
- hf_tracker.py
- is_nvidia.py
- kokoro_text_normalization.py
- llm_client.py
- main.py
- normalization_settings.py
- predownload_gui.py
- pronunciation_store.py
- queue_manager_gui.py
- queued_item.py
- shutdown.py
- spacy_contraction_resolver.py
- spacy_utils.py
- speaker_analysis.py
- speaker_configs.py
- subtitle_utils.py
- text_extractor.py
- utils.py
- VERSION
- voice_cache.py
- voice_formula_gui.py
- voice_formulas.py
- voice_metadata.py
- voice_profiles.py
- word_substitution.py
- abogen-webui.png
- abogen.gif
- abogen.png
- abogen2.png
- bg.jpg
- chapter_marker.png
- demo.ass
- demo.txt
- demo.wav
- queue.png
- README.md
- voice_mixer.png
- entities_step_overhaul_plan.md
- epub3_upgrade_plan.md
- contributing.md
- developer-guide.md
- getting-started.md
- testing.md
- tts-plugin-architecture.md
- __init__.py
- engine.py
- __init__.py
- engine.py
- pipeline.py
- __init__.py
- conftest.py
- engine_contract.py
- test_capabilities_contract.py
- test_engine_contract.py
- test_errors_contract.py
- test_host_context_contract.py
- test_integration.py
- test_loader_contract.py
- test_manifest_contract.py
- test_plugin_contract.py
- test_plugin_manager_contract.py
- test_session_contract.py
- test_types_contract.py
- abogen_debug_tts_samples.epub
- __init__.py
- __init__.py
- __init__.py
- __init__.py
- __init__.py
- __init__.py
- __init__.py
- __init__.py
- conftest.py
- test_all_plugins.py
- __init__.py
- conftest.py
- test_application_chapter_selection.py
- test_application_coverage.py
- test_audio_buffer.py
- test_audio_helpers.py
- test_audiobookshelf_client.py
- test_behavioral_regression.py
- test_book_handler_regression.py
- test_book_parser.py
- test_book_step_speaker_provider.py
- test_calibre_opds.py
- test_chapter_classification.py
- test_chapter_merge_normalize.py
- test_chapter_titles.py
- test_chunk_helpers.py
- test_chunk_text_for_tts_prefers_raw.py
- test_chunk_utils.py
- test_conversion_executor.py
- test_conversion_executor_unified.py
- test_conversion_planner.py
- test_conversion_request.py
- test_date_normalization_comprehensive.py
- test_debug_tts_samples.py
- test_domain_audio_buffer_extras.py
- test_domain_audio_sink.py
- test_domain_conversion_pipeline.py
- test_domain_imports.py
- test_domain_metadata_book.py
- test_domain_metadata_overrides.py
- test_domain_normalization_pipeline.py
- test_domain_pipeline_factory.py
- test_domain_progress.py
- test_domain_resolve_unique_path.py
- test_domain_sanitize_filename.py
- test_domain_speaker_metadata.py
- test_domain_subtitle_processor.py
- test_domain_text_chapters.py
- test_domain_text_utils.py
- test_domain_voice_resolution.py
- test_domain_voice_utils.py
- test_enums.py
- test_epub_content_slicing.py
- test_epub_exporter.py
- test_epub_heuristic_nav.py
- test_epub_html_nav_parsing.py
- test_epub_missing_file_error_handling.py
- test_epub_ncx_parsing.py
- test_epub_standard_nav.py
- test_exporters.py
- test_ffmetadata.py
- test_integration_hooks.py
- test_kokoro_plugin.py
- test_metadata_extraction.py
- test_metadata_helpers.py
- test_metadata_helpers_abs.py
- test_opds_import_metadata_mapping.py
- test_output_paths.py
- test_pdf_structure.py
- test_pending_job_metadata.py
- test_prepare_form.py
- test_preview_applies_manual_overrides.py
- test_pronunciation.py
- test_regression_fixes.py
- test_regression_webui_domain.py
- test_select_device.py
- test_service.py
- test_settings_integrations_secrets.py
- test_settings_registry.py
- test_settings_service.py
- test_speaker_analysis.py
- test_split_pattern.py
- test_subtitle_generation.py
- test_subtitle_writer.py
- test_supertonic_plugin.py
- test_synthesize_module.py
- test_text_extractor.py
- test_text_normalization.py
- test_title_builder.py
- test_utils_cache.py
- test_voice_fallback.py
- test_voice_formulas_pairs.py
- test_voice_loader.py
- test_voice_metadata.py
- test_voice_profiles.py
- test_voice_resolution.py
- test_voice_utils.py
- test_webui_form_limits.py
- .env.example
- .gitattributes
- .gitignore
- .python-version
- AGENTS.md
- build_pypi.py
- CHANGELOG.md
- docker-compose.webui.yml
- docker-compose.yaml
- LICENSE
- pyproject.toml
- README.md
- WINDOWS_INSTALL.bat
# Installation Guide
1. Get the code
git clone https://github.com/denizsafak/abogen
Downloads the entire project code from GitHub to your computer.
cd abogen
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommendedpip install torch==2.8.0+cu128 torchvision==0.23.0+cu128 torchaudio==2.8.0 --index-url https://download.pytorch.org/whl/cu128
Installs the package published on PyPI directly โ no need to clone the source.
pip install abogen
Installs the package published on PyPI directly โ no need to clone the source.
brew install espeak-ng
Installs the pre-built package via Homebrew โ no source build required.
pip3 install abogen
Installs the package published on PyPI directly โ no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t abogen .
Builds a runnable image based on the Dockerfile.
docker run --rm \
Runs the built image as an actual container.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
docker build -f abogen/Dockerfile -t abogen-gpu .
Builds a runnable image based on the Dockerfile.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
4. Python
EasyPrerequisites
python -m venv venv
Runs the Python script (or module).
pip install torch==2.8.0+cu128 torchvision==0.23.0+cu128 torchaudio==2.8.0 --index-url https://download.pytorch.org/whl/cu128
Installs the package published on PyPI directly โ no need to clone the source.
pip install abogen
Installs the package published on PyPI directly โ no need to clone the source.
python3 -m venv venv
Runs the Python script (or module).
pip3 install abogen
Installs the package published on PyPI directly โ no need to clone the source.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)