CLI tool to convert txt file to ebook format
Project description
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
Usage
Showing help message of command-line options:
txt2ebook --help
usage: txt2ebook [-of OUTPUT_FOLDER] [-p] [-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')
-l, --language LANGUAGE
language of the ebook (default: 'None')
-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 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>.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file txt2ebook-0.1.146.tar.gz
.
File metadata
- Download URL: txt2ebook-0.1.146.tar.gz
- Upload date:
- Size: 211.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
c7fd0bf854c4a5d0e5e6b9cf51c3c4911fa23dd8ae0c4c3adfcc54bb06cfad47
|
|
MD5 |
a326745cd6c79a9adaf45d395f347b52
|
|
BLAKE2b-256 |
1ed1446e6273b45032330da564dc8f6f1e6617448119252c3a2e2607fbec273d
|
File details
Details for the file txt2ebook-0.1.146-py3-none-any.whl
.
File metadata
- Download URL: txt2ebook-0.1.146-py3-none-any.whl
- Upload date:
- Size: 74.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
bd07160faeffbc18b6e360f875e5292a3e1338f9d87071f968492da9387cdd85
|
|
MD5 |
970a52906a71d053e4a5dd7ba6b230d9
|
|
BLAKE2b-256 |
f82655927340e680a930ed14ef7e604e920c2d241aaf9f45fd3f0332f9cd95c6
|