46 lines
2.0 KiB
Markdown
46 lines
2.0 KiB
Markdown
# epub-tts
|
|
|
|
Python project to gather several projects that convert EPUB files to audiobooks (M4B files, mostly), with different TTS backends.
|
|
|
|
# Requirements
|
|
|
|
Recent Python (>=3.11), pip (>=22.3), some sort of virtula environment recommended (such as the builtin venv package), and a Rust compatible platform (avoid embedded systems which do not have pre-built binaries for the compiled requirements, e.g., Android's Termux try to build everything from sources and fails miserably when doing so).
|
|
|
|
# Installation
|
|
|
|
1. [Optional] Create virtual environment anywhere, e.g.: `python -m venv .venv` and activate it.
|
|
- See your virtual environment package's documentation, such as [`venv`](https://docs.python.org/3/library/venv.html)
|
|
- A virtual environment may be “activated” using a script in its binary directory (`bin` on POSIX; `Scripts` on Windows).
|
|
- Example: `source .venv/bin/activate` or `.venv\Scripts\Activate.ps1`
|
|
|
|
2. Install depedencies with `pip install .`, which should read the `[dependencies]` section in [pyproject.toml](./pyproject.toml) or `pip install -e '.[dev]'` to install in editable mode, including `dev` dependencies section (`[optional-depedencies]`).
|
|
|
|
3. Test install running `epub-tts --version`
|
|
- Make sure the venv is activated or that pip installed the package in your PATH
|
|
|
|
# Sample EPUB download
|
|
|
|
After cloning with submodules, the repository now includes the EPUB 3 sample collection under `src/vendor/epub3-samples`.
|
|
|
|
Use the new console entrypoints to export the Moby Dick samples as EPUB files:
|
|
|
|
- `download-moby-dick` creates `.tmp-samples/moby-dick.epub`
|
|
- `download-moby-dick-media-overlays` creates `.tmp-samples/moby-dick-mo.epub`
|
|
- `download-epub-minimal` creates `.tmp-samples/minimal.epub`
|
|
|
|
The staging directory `.tmp-samples/` is included in `.gitignore` so generated artifacts stay out of version control.
|
|
|
|
#
|
|
|
|
# Citation
|
|
|
|
There is no need for academic citation specifics, just mention this project's URL and author, according to [LICENSE](./LICENSE).
|
|
|
|
# License
|
|
|
|
See [LICENSE](./LICENSE).
|
|
|
|
# Agents
|
|
|
|
See [AGENTS.md](./AGENTS.md).
|