| Name | epub-simplifier JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | A command-line tool to simplify language in EPUB books |
| upload_time | 2024-03-20 11:21:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
epub
language
simplification
tool
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# EPUB Simplifier
[
](https://pypi.python.org/pypi/epub-simplifier)
[
](https://pypi.python.org/pypi/epub-simplifier)
[
](https://coveralls.io/r/bubenkoff/epub-simplifier)
## Description
EPUB Simplifier is a command-line tool designed to convert text within EPUB files into a simplified language at a selected proficiency level. This tool aims to make literature more accessible to language learners by simplifying complex language structures and vocabulary.
> [!WARNING]
> It uses OpenAI API and requires an API key to work, which is not provided with the package. It can also be quite expensive to use, depending on the size of the book.
## Motivation
The idea for this tool was inspired by the need to make literature more accessible to language learners. Many language learners struggle to read books in their target language due to the complexity of the language used in literature. This tool addresses this issue by simplifying the language used in books to make them more accessible to language learners at different proficiency levels.
In particular, for the Dutch language, there is a lack of literature in accessible language in electronic format. Having the text on an e-book allows using built-in dictionaries and other tools to help comprehensively understand the text.
## Installation
To install EPUB Simplifier, follow these steps:
``
pip install epub-simplifier
``
## Usage
After installation, you can use the EPUB Simplifier tool directly from your command line. The basic command structure is as follows:
``
export OPENAI_API_KEY=your_api_key
``
Optionally, set the organization ID if you have one:
``
export OPENAI_ORG_ID=your_org_id
``
Run the command:
``
epub-simplify --help
``
## Example Command
``
epub-simplify original_book.epub simplified_book.epub Dutch B1
``
This command will read `original_book.epub`, simplify its contents, and save the result as `simplified_book.epub`.
## Requirements
The dependencies will be installed automatically during the package installation process.
## Feedback and Contributions
Your feedback and contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue on the GitHub repository or submit a pull request with your changes.
## License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "epub-simplifier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "epub, language, simplification, tool",
"author": null,
"author_email": "Anatolii Bubenkov <bubenkoff@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/60/ed/edb9cfe1395fa661f592c8d3a59e772346c7e743919db4b5259cd2ad88a7/epub-simplifier-0.0.4.tar.gz",
"platform": null,
"description": "# EPUB Simplifier\n\n\n[\n](https://pypi.python.org/pypi/epub-simplifier)\n[\n](https://pypi.python.org/pypi/epub-simplifier)\n[\n](https://coveralls.io/r/bubenkoff/epub-simplifier)\n\n## Description\nEPUB Simplifier is a command-line tool designed to convert text within EPUB files into a simplified language at a selected proficiency level. This tool aims to make literature more accessible to language learners by simplifying complex language structures and vocabulary.\n\n> [!WARNING]\n> It uses OpenAI API and requires an API key to work, which is not provided with the package. It can also be quite expensive to use, depending on the size of the book.\n\n## Motivation\nThe idea for this tool was inspired by the need to make literature more accessible to language learners. Many language learners struggle to read books in their target language due to the complexity of the language used in literature. This tool addresses this issue by simplifying the language used in books to make them more accessible to language learners at different proficiency levels.\n\nIn particular, for the Dutch language, there is a lack of literature in accessible language in electronic format. Having the text on an e-book allows using built-in dictionaries and other tools to help comprehensively understand the text.\n\n## Installation\nTo install EPUB Simplifier, follow these steps:\n\n``\npip install epub-simplifier\n``\n\n## Usage\nAfter installation, you can use the EPUB Simplifier tool directly from your command line. The basic command structure is as follows:\n\n``\nexport OPENAI_API_KEY=your_api_key\n``\n\nOptionally, set the organization ID if you have one:\n\n``\nexport OPENAI_ORG_ID=your_org_id\n``\n\nRun the command:\n\n``\nepub-simplify --help\n``\n\n## Example Command\n\n``\nepub-simplify original_book.epub simplified_book.epub Dutch B1\n``\n\nThis command will read `original_book.epub`, simplify its contents, and save the result as `simplified_book.epub`.\n\n## Requirements\nThe dependencies will be installed automatically during the package installation process.\n\n## Feedback and Contributions\nYour feedback and contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue on the GitHub repository or submit a pull request with your changes.\n\n## License\nMIT \n",
"bugtrack_url": null,
"license": null,
"summary": "A command-line tool to simplify language in EPUB books",
"version": "0.0.4",
"project_urls": {
"Issues": "https://github.com/bubenkoff/epub-simplifier/issues",
"Repository": "https://github.com/bubenkoff/epub-simplifier.git"
},
"split_keywords": [
"epub",
" language",
" simplification",
" tool"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2073a6573f73d8e2312c3a2d8d1ce32b7b173a1dad9ed21effdde38b4379d154",
"md5": "8e9f1dd42b53d0079c6ba4220a299199",
"sha256": "ab7359aeb192bb1f9d3ffad1a3c57c6cdd973b4586daf20ad26fe2ca2710f2e5"
},
"downloads": -1,
"filename": "epub_simplifier-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e9f1dd42b53d0079c6ba4220a299199",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8254,
"upload_time": "2024-03-20T11:21:14",
"upload_time_iso_8601": "2024-03-20T11:21:14.773430Z",
"url": "https://files.pythonhosted.org/packages/20/73/a6573f73d8e2312c3a2d8d1ce32b7b173a1dad9ed21effdde38b4379d154/epub_simplifier-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60ededb9cfe1395fa661f592c8d3a59e772346c7e743919db4b5259cd2ad88a7",
"md5": "e3ef08cee01b2305101a4bb6ee4b1f12",
"sha256": "e3a782fd1b8fd9904d31bb16d99bc4b64ad6a0cbe4fad39181d03732fcba506c"
},
"downloads": -1,
"filename": "epub-simplifier-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "e3ef08cee01b2305101a4bb6ee4b1f12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9075,
"upload_time": "2024-03-20T11:21:16",
"upload_time_iso_8601": "2024-03-20T11:21:16.783466Z",
"url": "https://files.pythonhosted.org/packages/60/ed/edb9cfe1395fa661f592c8d3a59e772346c7e743919db4b5259cd2ad88a7/epub-simplifier-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 11:21:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bubenkoff",
"github_project": "epub-simplifier",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "epub-simplifier"
}
