Skip to main content

txt2ebook

A console tool to convert txt file to different ebook formats.

Installation

Stable version From PyPI:

uv tool install txt2ebook

Upgrade to latest stable version:

uv tool upgrade txt2ebook

Add autocompletion to your Bash config:

eval "$(register-python-argcomplete tte)"
eval "$(register-python-argcomplete txt2ebook)"

Usage

Showing help message of command-line options:

txt2ebook --help
usage: txt2ebook [-of OUTPUT_FOLDER] [-p] [-y] [-l LANGUAGE] [-rw] [-q] [-v]
                 [-d] [-h] [-V]
                 {env,epub,gmi,massage,md,parse,pdf,tex,typ} ...

txt2ebook/tte is a cli tool to convert txt file to ebook format.

website: https://github.com/kianmeng/txt2ebook
changelog: https://github.com/kianmeng/txt2ebook/blob/master/CHANGELOG.md
issues: https://github.com/kianmeng/txt2ebook/issues

positional arguments:
  {env,epub,gmi,massage,md,parse,pdf,tex,typ}
      sub-command help
    env
      print environment information for bug reporting
    epub
      generate ebook in EPUB format
    gmi
      generate ebook in Gemtext format
    massage
      massage the source txt file
    md
      generate ebook in Markdown format
    parse
      parse and validate the txt file
    pdf
      generate ebook in Markdown format
    tex
      generate ebook in TeX/PDF format
    typ
      generate ebook in Typst format

options:
  -of, --output-folder OUTPUT_FOLDER
      set default output folder (default: 'output')
  -p, --purge
      remove converted ebooks specified by --output-folder option (default: 'False')
  -y, --yes
      assume yes to all prompts (default: 'False')
  -rw, --raise-on-warning
      raise exception and stop parsing upon warning
  -q, --quiet
      suppress all logging
  -v, --verbose
      show verbosity of debugging log, use -vv, -vvv for more details
  -d, --debug
      show debugging log and stacktrace
  -h, --help
      show this help message and exit
  -V, --version
      show program's version number and exit

Convert a txt file into epub:

txt2ebook ebook.txt

Copyright and License

Copyright (c) 2021,2022,2023,2024,2025,2026 Kian-Meng Ang

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

The fish logo used in the documentation generated by Sphinx is a public domain drawing of Troschel's parrotfish (Chlorurus troschelii Var. A.) from https://commons.wikimedia.org/entity/M18506436. 18506436>.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

txt2ebook-0.1.205.tar.gz (43.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

txt2ebook-0.1.205-py3-none-any.whl (68.7 kB view details)

Uploaded Python 3

File details

Details for the file txt2ebook-0.1.205.tar.gz.

File metadata

  • Download URL: txt2ebook-0.1.205.tar.gz
  • Upload date:
  • Size: 43.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for txt2ebook-0.1.205.tar.gz
Algorithm Hash digest
SHA256 ea0c8ceecf670ec4e032e80748073ecbf7eaa3b20fc14f0125b6b23026160f22
MD5 82af3b7b994db38b9ba920e19e71a5b1
BLAKE2b-256 683247122389b0d48f91deb09b3ea29ac673b813f97f0f9bedbaab4643924b5a

See more details on using hashes here.

File details

Details for the file txt2ebook-0.1.205-py3-none-any.whl.

File metadata

  • Download URL: txt2ebook-0.1.205-py3-none-any.whl
  • Upload date:
  • Size: 68.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for txt2ebook-0.1.205-py3-none-any.whl
Algorithm Hash digest
SHA256 720d57ffa20b4c40ccb29eedb0a8bf26c3ec09b9861f6cbb9c77486b69fdaa7b
MD5 f6119b1c902e893c140c981b12759824
BLAKE2b-256 0594b6e398871a4aa91265cfcfe0245afe3a5acbed523022f02ba033713a920b

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page