Skip to main content

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:

python3 -m pip install txt2ebook

Latest development version from GitHub:

python3 -m pip install -e git+https://github.com/kianmeng/txt2ebook.git

Usage

Showing help message of command-line options:

txt2ebook --help
usage: txt2ebook [-of OUTPUT_FOLDER] [-p] [-f {epub,gmi,md,pdf,txt,typ
                 [-t TITLE] [-l LANGUAGE] [-a AUTHOR] [-tr TRANSLATOR]
                 [-c IMAGE_FILENAME] [-w WIDTH] [-ff FILENAME_FORMAT]
                 [-ps SEPARATOR] [-pz PAGE_SIZE] [-rd REGEX] [-rvc REGEX]
                 [-rv REGEX] [-rc REGEX] [-rt REGEX] [-ra REGEX] [-rl REGEX]
                 [-rr REGEX REGEX] [-et {clean,condense,noindent}] [-vp] [-tp]
                 [-sp] [-ss] [-toc] [-hn] [-fw] [-rw] [-ow] [-q] [-v] [-y]
                 [-d] [-h] [-V]
                 TXT_FILENAME [EBOOK_FILENAME]

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:
  TXT_FILENAME
      source text filename
  EBOOK_FILENAME
      converted ebook filename (default: 'TXT_FILENAME.epub')

optional arguments:
  -of OUTPUT_FOLDER, --output-folder OUTPUT_FOLDER
      set default output folder (default: 'output')
  -p, --purge
      remove converted ebooks specified by --output-folder option (default: 'False')
  -f {epub,gmi,md,pdf,txt,typ}, --format {epub,gmi,md,pdf,txt,typ}
      ebook format (default: 'epub')
  -t TITLE, --title TITLE
      title of the ebook (default: 'None')
  -l LANGUAGE, --language LANGUAGE
      language of the ebook (default: 'None')
  -a AUTHOR, --author AUTHOR
      author of the ebook (default: '[]')
  -tr TRANSLATOR, --translator TRANSLATOR
      translator of the ebook (default: '[]')
  -ff FILENAME_FORMAT, --filename-format FILENAME_FORMAT
      the output filename format (default: TXT_FILENAME [EBOOK_FILENAME])
      1 - title_authors.EBOOK_EXTENSION
      2 - authors_title.EBOOK_EXTENSION
  -ps SEPARATOR, --paragraph_separator SEPARATOR
      paragraph separator (default: '\n\n')
  -rd REGEX, --regex-delete REGEX
      regex to delete word or phrase (default: '[]')
  -rvc REGEX, --regex-volume-chapter REGEX
      regex to parse volume and chapter header (default: by LANGUAGE)
  -rv REGEX, --regex-volume REGEX
      regex to parse volume header (default: by LANGUAGE)
  -rc REGEX, --regex-chapter REGEX
      regex to parse chapter header (default: by LANGUAGE)
  -rt REGEX, --regex-title REGEX
      regex to parse title of the book (default: by LANGUAGE)
  -ra REGEX, --regex-author REGEX
      regex to parse author of the book (default: by LANGUAGE)
  -rl REGEX, --regex-delete-line REGEX
      regex to delete whole line (default: '[]')
  -rr REGEX REGEX, --regex-replace REGEX REGEX
      regex to search and replace (default: '[]')
  -tp, --test-parsing
      test parsing for volume/chapter header
  -ss, --sort-volume-and-chapter
      short volume and chapter
  -rw, --raise-on-warning
      raise exception and stop parsing upon warning
  -ow, --overwrite
      overwrite massaged TXT_FILENAME
  -q, --quiet
      suppress all logging
  -v, --verbose
      show verbosity of debugging log, use -vv, -vvv for more details
  -y, --yes
      yes to prompt
  -d, --debug
      show debugging log and stacktrace
  -h, --help
      show this help message and exit
  -V, --version
      show program's version number and exit

--format epub:
  -c IMAGE_FILENAME, --cover IMAGE_FILENAME
      cover of the ebook
  -et {clean,condense,noindent}, --epub-template {clean,condense,noindent}
      CSS template for epub ebook (default: 'clean')
  -vp, --volume-page
      generate each volume as separate page

--format pdf:
  -pz PAGE_SIZE, --page-size PAGE_SIZE
      page size of the ebook (default: 'None')

--format txt:
  -w WIDTH, --width WIDTH
      width for line wrapping
  -sp, --split-volume-and-chapter
      split volume or chapter into separate file and ignore the --overwrite option
  -toc, --table-of-content
      add table of content

--language zh-cn / --language zh-tw:
  -hn, --header-number
      convert section header from words to numbers
  -fw, --fullwidth
      convert ASCII character from halfwidth to fullwidth

Convert a txt file into epub:

txt2ebook ebook.txt

Copyright and License

Copyright (c) 2021,2022,2023 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.

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

txt2ebook-0.1.67.tar.gz (36.4 kB view details)

Uploaded Source

Built Distribution

txt2ebook-0.1.67-py3-none-any.whl (59.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: txt2ebook-0.1.67.tar.gz
  • Upload date:
  • Size: 36.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.8.18 Linux/6.5.0-14-generic

File hashes

Hashes for txt2ebook-0.1.67.tar.gz
Algorithm Hash digest
SHA256 547b2245b13636d32b2f86f08a8beb4495e894256904ed2f64bb568c1ae96e0a
MD5 979083786a888d64e11580009ef51455
BLAKE2b-256 85c193aa418204e3e6de29e6b395e78e495d57aa10f23a2211616be70c2c3b71

See more details on using hashes here.

File details

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

File metadata

  • Download URL: txt2ebook-0.1.67-py3-none-any.whl
  • Upload date:
  • Size: 59.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.8.18 Linux/6.5.0-14-generic

File hashes

Hashes for txt2ebook-0.1.67-py3-none-any.whl
Algorithm Hash digest
SHA256 7a2997c3bf5fb9611b04e64439b17639f2c49243317dff780448ed1522b9001e
MD5 9c56f204b6df81c5adb9b6b7b10a0e4e
BLAKE2b-256 04b0bc34da54f60682a1968f924c7c09bc7c64f160fb07d5dc7f4501fa7f435e

See more details on using hashes here.

Supported by

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