# TXT2EPUB
[中文说明](README.zh.md)
A simple tool for converting TXT books into ePub.
## Installation
You'll first need to have Python3 and Pip installed. If you're using Windows, then the default Python installer will come with Pip. If you're using Linux, you may need to install an extra package like `python3-pip`. The exact package name depends on your distro.
Then, execute the following command to install TXT2EPUB.
```shell
pip install txt2epub
```
## Usage
You may convert a file from the command line:
```shell
txt2epub convert -i <input> -o <output>
```
...or using the GUI:
```shell
txt2epub gui
```
## Chapter Detection
This program detects the book chapters and chapter titles following the standard TXT book format:
- Chapters are separated by three two new lines (i.e., `\n\n\n`)
- The first line in a new chapter is the chapter's title.
For example, in the text below, there are two chapters with titles "Chapter 1" and "Chapter 2."
```txt
Chapter 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec at sapien ante.
Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae.
Chapter 2
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec at sapien ante.
Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/k4yt3x/txt2epub/",
"name": "txt2epub",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "ebook",
"author": "",
"author_email": "K4YT3X <i@k4yt3x.com>",
"download_url": "https://files.pythonhosted.org/packages/01/72/3a1399615824fe68026a1adf6100c236389810d70a29cdaf9a16713c5c6d/txt2epub-1.1.2.tar.gz",
"platform": null,
"description": "# TXT2EPUB\n\n[\u4e2d\u6587\u8bf4\u660e](README.zh.md)\n\nA simple tool for converting TXT books into ePub.\n\n\n\n## Installation\n\nYou'll first need to have Python3 and Pip installed. If you're using Windows, then the default Python installer will come with Pip. If you're using Linux, you may need to install an extra package like `python3-pip`. The exact package name depends on your distro.\n\nThen, execute the following command to install TXT2EPUB.\n\n```shell\npip install txt2epub\n```\n\n## Usage\n\nYou may convert a file from the command line:\n\n```shell\ntxt2epub convert -i <input> -o <output>\n```\n\n...or using the GUI:\n\n```shell\ntxt2epub gui\n```\n\n## Chapter Detection\n\nThis program detects the book chapters and chapter titles following the standard TXT book format:\n\n- Chapters are separated by three two new lines (i.e., `\\n\\n\\n`)\n- The first line in a new chapter is the chapter's title.\n\nFor example, in the text below, there are two chapters with titles \"Chapter 1\" and \"Chapter 2.\"\n\n```txt\nChapter 1\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Donec at sapien ante.\n\nVestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae.\n\n\nChapter 2\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Donec at sapien ante.\n\nVestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae.\n```\n",
"bugtrack_url": null,
"license": "GPL-2.0-only",
"summary": "A simple TXT to ePub converter",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/k4yt3x/txt2epub/"
},
"split_keywords": [
"ebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd7a615a5e0b49cbf4122e2481c839f126c6aff721ebb634823ca11e728f4df0",
"md5": "257046625ffc4369ba03c79d26757419",
"sha256": "08ab18d43bd873ae050c19664bf4dcb13572fd6d4b02412d473f31e0a980644c"
},
"downloads": -1,
"filename": "txt2epub-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "257046625ffc4369ba03c79d26757419",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12684,
"upload_time": "2023-07-19T17:06:38",
"upload_time_iso_8601": "2023-07-19T17:06:38.482919Z",
"url": "https://files.pythonhosted.org/packages/dd/7a/615a5e0b49cbf4122e2481c839f126c6aff721ebb634823ca11e728f4df0/txt2epub-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01723a1399615824fe68026a1adf6100c236389810d70a29cdaf9a16713c5c6d",
"md5": "18d7bb0dd9a5fe9a93fda58cc8300e7f",
"sha256": "06e15757e7100587ced2e33ba6c9940b06a3785eec0d42e802c60f071b9780af"
},
"downloads": -1,
"filename": "txt2epub-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "18d7bb0dd9a5fe9a93fda58cc8300e7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11200,
"upload_time": "2023-07-19T17:06:39",
"upload_time_iso_8601": "2023-07-19T17:06:39.776853Z",
"url": "https://files.pythonhosted.org/packages/01/72/3a1399615824fe68026a1adf6100c236389810d70a29cdaf9a16713c5c6d/txt2epub-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 17:06:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "k4yt3x",
"github_project": "txt2epub",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "txt2epub"
}
JSON
