| Name | epub-to-text JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A Python package to extract text from EPUB files |
| upload_time | 2024-05-31 04:50:05 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# EPUB to text
## Overview
`epub_to_text` is a Python package designed to extract content from EPUB files and export it in various formats such as text, JSON, and Markdown. This package can be used to feed content into AI models for summarization, knowledge base building, and other applications.
## Features
- Extracts content from EPUB files by chapters.
- Exports content as plain text, JSON, or Markdown.
- Handles creation of export directories.
- Provides a command-line interface (CLI) for easy usage.
## Installation
### Prerequisites
- Python 3.6 or higher
### Required Packages
The following packages are required:
- `ebooklib==0.17.1`
- `beautifulsoup4==4.9.3`
- `markdown==3.3.4`
### Installing the Package
You can install the package directly from PyPI:
```sh
pip install epub_to_text
```
## Usage
### Command-Line Interface (CLI)
The package provides a CLI for easy extraction and export of EPUB content. The command `epub-extract` can be used from the terminal.
### Basic Usage
Navigate to the directory containing your EPUB file and run:
```sh
epub-extract path_to_your_epub_file.epub --text --json --markdown
Raw data
{
"_id": null,
"home_page": null,
"name": "epub-to-text",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/d3/cf/cecfb8512ed73c00f6f7b07dc11c101b017c6c203cc8e277bd8b16503124/epub_to_text-0.1.1.tar.gz",
"platform": null,
"description": "# EPUB to text\r\n\r\n## Overview\r\n\r\n`epub_to_text` is a Python package designed to extract content from EPUB files and export it in various formats such as text, JSON, and Markdown. This package can be used to feed content into AI models for summarization, knowledge base building, and other applications.\r\n\r\n## Features\r\n\r\n- Extracts content from EPUB files by chapters.\r\n- Exports content as plain text, JSON, or Markdown.\r\n- Handles creation of export directories.\r\n- Provides a command-line interface (CLI) for easy usage.\r\n\r\n## Installation\r\n\r\n### Prerequisites\r\n\r\n- Python 3.6 or higher\r\n\r\n### Required Packages\r\n\r\nThe following packages are required:\r\n\r\n- `ebooklib==0.17.1`\r\n- `beautifulsoup4==4.9.3`\r\n- `markdown==3.3.4`\r\n\r\n### Installing the Package\r\n\r\nYou can install the package directly from PyPI:\r\n\r\n```sh\r\npip install epub_to_text\r\n```\r\n\r\n## Usage\r\n\r\n### Command-Line Interface (CLI)\r\n\r\nThe package provides a CLI for easy extraction and export of EPUB content. The command `epub-extract` can be used from the terminal.\r\n\r\n### Basic Usage\r\n\r\nNavigate to the directory containing your EPUB file and run:\r\n\r\n```sh\r\nepub-extract path_to_your_epub_file.epub --text --json --markdown\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package to extract text from EPUB files",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef70a5919cc3249aa78b12cab90a3fa4d4cdda01c00081ab3bde764d1ed8c722",
"md5": "01f4ef1ebc709574d786e132e5caf49c",
"sha256": "9366e3bb358fd78b5474fab7d35ac8f5e02d79ceab7a1e9fe00b8ed52e95ae98"
},
"downloads": -1,
"filename": "epub_to_text-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01f4ef1ebc709574d786e132e5caf49c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5060,
"upload_time": "2024-05-31T04:50:03",
"upload_time_iso_8601": "2024-05-31T04:50:03.076715Z",
"url": "https://files.pythonhosted.org/packages/ef/70/a5919cc3249aa78b12cab90a3fa4d4cdda01c00081ab3bde764d1ed8c722/epub_to_text-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3cfcecfb8512ed73c00f6f7b07dc11c101b017c6c203cc8e277bd8b16503124",
"md5": "ca84f82e0f2b59fa7c05595b62f7e211",
"sha256": "4d69887f1283e6f152a4430c208c9add608f6871c330fc23c2ae25d4cedc188a"
},
"downloads": -1,
"filename": "epub_to_text-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ca84f82e0f2b59fa7c05595b62f7e211",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3897,
"upload_time": "2024-05-31T04:50:05",
"upload_time_iso_8601": "2024-05-31T04:50:05.239384Z",
"url": "https://files.pythonhosted.org/packages/d3/cf/cecfb8512ed73c00f6f7b07dc11c101b017c6c203cc8e277bd8b16503124/epub_to_text-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-31 04:50:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "epub-to-text"
}
