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] [-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 PDF 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 (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>.

Metadata

Release files for txt2ebook 0.1.218

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for txt2ebook 0.1.218
File Size Uploaded Provenance Actions
txt2ebook-0.1.218.tar.gz 51.0 kB Without provenance Details for txt2ebook-0.1.218.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for txt2ebook 0.1.218
File Interpreter ABI Platform Actions
txt2ebook-0.1.218-py3-none-any.whl Python 3 none any Details for txt2ebook-0.1.218-py3-none-any.whl

Total release size: 126.0 kB

Release files / txt2ebook-0.1.218.tar.gz

Download URL txt2ebook-0.1.218.tar.gz
Size 51.0 kB
Tags Source
SHA-256 checksum
How to use checksums
7e867b5e4a179a95cc4e2e33e2ba87d7502ed4cac5ff11498e0f54195c519cbc
BLAKE2b-256 checksum
How to use checksums
c49d2f39b8b41a15a75d99f0f358d2379e37926bb918bc0e803f6b6e30176271
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.10","id":"stonking","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / txt2ebook-0.1.218-py3-none-any.whl

Download URL txt2ebook-0.1.218-py3-none-any.whl
Size 75.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bfb2fff73091ae35e146e4e69bc7cebdf73ae35de4fe29e00bd70b424b110b23
BLAKE2b-256 checksum
How to use checksums
0106bcfc85f454a0d947f8d0a1c9093daefbaf0afdccae99a0a7b4ebed6762fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.10","id":"stonking","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for txt2ebook 0.1.218

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.218 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page