# txt2ebook
A console tool to convert txt file to different ebook formats.
## Installation
Stable version From PyPI:
```console
python3 -m pip install txt2ebook
```
Upgrade to latest stable version:
```console
python3 -m pip install txt2ebook --upgrade
```
Latest development version from GitHub:
```console
python3 -m pip install -e git+https://github.com/kianmeng/txt2ebook.git
```
## Usage
Showing help message of command-line options:
```console
txt2ebook --help
```
<!--help !-->
```console
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 Markdown 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
```
<!--help !-->
Convert a txt file into epub:
```console
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>.
Raw data
{
"_id": null,
"home_page": "https://github.com/kianmeng/txt2ebook",
"name": "txt2ebook",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "txt, ebook, epub, cjk",
"author": "Kian-Meng Ang",
"author_email": "kianmeng@cpan.org",
"download_url": "https://files.pythonhosted.org/packages/d6/6d/ca9c3d856ddc4598790642e9ed5053436ca8f5520838cadc7544dda4d942/txt2ebook-0.1.128.tar.gz",
"platform": null,
"description": "# txt2ebook\n\nA console tool to convert txt file to different ebook formats.\n\n## Installation\n\nStable version From PyPI:\n\n```console\npython3 -m pip install txt2ebook\n```\n\nUpgrade to latest stable version:\n\n```console\npython3 -m pip install txt2ebook --upgrade\n```\n\nLatest development version from GitHub:\n\n```console\npython3 -m pip install -e git+https://github.com/kianmeng/txt2ebook.git\n```\n\n## Usage\n\nShowing help message of command-line options:\n\n```console\ntxt2ebook --help\n```\n\n<!--help !-->\n\n```console\nusage: txt2ebook [-of OUTPUT_FOLDER] [-p] [-l LANGUAGE] [-rw] [-q] [-v] [-d]\n [-h] [-V]\n {env,epub,gmi,massage,md,parse,pdf,tex,typ} ...\n\ntxt2ebook/tte is a cli tool to convert txt file to ebook format.\n\nwebsite: https://github.com/kianmeng/txt2ebook\nchangelog: https://github.com/kianmeng/txt2ebook/blob/master/CHANGELOG.md\nissues: https://github.com/kianmeng/txt2ebook/issues\n\npositional arguments:\n {env,epub,gmi,massage,md,parse,pdf,tex,typ}\n sub-command help\n env\n print environment information for bug reporting\n epub\n generate ebook in EPUB format\n gmi\n generate ebook in Markdown format\n massage\n massage the source txt file\n md\n generate ebook in Markdown format\n parse\n parse and validate the txt file\n pdf\n generate ebook in Markdown format\n tex\n generate ebook in TeX/PDF format\n typ\n generate ebook in Typst format\n\noptions:\n -of, --output-folder OUTPUT_FOLDER\n set default output folder (default: 'output')\n -p, --purge\n remove converted ebooks specified by --output-folder option (default: 'False')\n -l, --language LANGUAGE\n language of the ebook (default: 'None')\n -rw, --raise-on-warning\n raise exception and stop parsing upon warning\n -q, --quiet\n suppress all logging\n -v, --verbose\n show verbosity of debugging log, use -vv, -vvv for more details\n -d, --debug\n show debugging log and stacktrace\n -h, --help\n show this help message and exit\n -V, --version\n show program's version number and exit\n```\n\n<!--help !-->\n\nConvert a txt file into epub:\n\n```console\ntxt2ebook ebook.txt\n```\n\n## Copyright and License\n\nCopyright (c) 2021,2022,2023,2024,2025 Kian-Meng Ang\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU Affero General Public License as published by the Free\nSoftware Foundation, either version 3 of the License, or (at your option) any\nlater version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License along\nwith this program. If not, see <https://www.gnu.org/licenses/>.\n\nThe fish logo used in the documentation generated by Sphinx is a public domain\ndrawing of Troschel's parrotfish (Chlorurus troschelii Var. A.) from\n<https://commons.wikimedia.org/entity/M18506436>.\n18506436>.\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "CLI tool to convert txt file to ebook format",
"version": "0.1.128",
"project_urls": {
"Homepage": "https://github.com/kianmeng/txt2ebook",
"Repository": "https://github.com/kianmeng/txt2ebook"
},
"split_keywords": [
"txt",
" ebook",
" epub",
" cjk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5df06050c90cb92ce9fb5d5784c31b611edb92767e9d5bbf42f105395a015b63",
"md5": "076d61d8752adb738fac53f42a67abc6",
"sha256": "6e904bcbc5bf03e63ac42c6de0909101d1cae064bca45b88778e7f3d2bbdd2ad"
},
"downloads": -1,
"filename": "txt2ebook-0.1.128-py3-none-any.whl",
"has_sig": false,
"md5_digest": "076d61d8752adb738fac53f42a67abc6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 74479,
"upload_time": "2025-02-23T07:37:45",
"upload_time_iso_8601": "2025-02-23T07:37:45.434717Z",
"url": "https://files.pythonhosted.org/packages/5d/f0/6050c90cb92ce9fb5d5784c31b611edb92767e9d5bbf42f105395a015b63/txt2ebook-0.1.128-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d66dca9c3d856ddc4598790642e9ed5053436ca8f5520838cadc7544dda4d942",
"md5": "bf1754c663a345e93f853459d6aed7df",
"sha256": "4f9e39beaa07f0000aa712ce451e2727449406bcc8d3c165380d681c0467381b"
},
"downloads": -1,
"filename": "txt2ebook-0.1.128.tar.gz",
"has_sig": false,
"md5_digest": "bf1754c663a345e93f853459d6aed7df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 40573,
"upload_time": "2025-02-23T07:37:47",
"upload_time_iso_8601": "2025-02-23T07:37:47.865892Z",
"url": "https://files.pythonhosted.org/packages/d6/6d/ca9c3d856ddc4598790642e9ed5053436ca8f5520838cadc7544dda4d942/txt2ebook-0.1.128.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 07:37:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kianmeng",
"github_project": "txt2ebook",
"github_not_found": true,
"lcname": "txt2ebook"
}
JSON
