| Name | epubedit JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | a python package to read ePub infos and edit it. |
| upload_time | 2024-07-22 16:36:19 |
| maintainer | None |
| docs_url | None |
| author | Youyu |
| requires_python | >=3.0 |
| license | Copyright (c) 2024 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
epub
ebook
metadata search
content.opf
ebook-reader
ebook-editor
epub-tools
digital-publishing
ebook-converter
ebook-management
ebook-library
metadata
metadata-editor
epub-metadata
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--
* @Date: 2024-07-18 21:44:17
* @LastEditors: youyu 2000601104@cjlu.edu.cn
* @LastEditTime: 2024-07-22 23:47:12
-->
# EpubEdit
> Regarding epubedit, this is a Python package for viewing and editing epub file metadata
## Installation and Usage
* Installation:
``` Python
pip install epubedit
```
* Usage
``` Python
from epubedit import read_epub_info
book = read_epub_info('book_name')
book.get_infos()
```
## Functions
### read_info(str) -> str | list
Read the value of a single metadata
Supported parameters:
[
'epub_version',
"book_name",
"author_name",
"publisher_name",
"ISBN",
"ASIN",
"bookid",
"describe",
"language",
"rights",
"publication_date",
]
Example:
``` Python
from epubedit import read_epub_info
book = read_epub_info("Moby Dick.epub")
print(book.get_info('book_name'))
```
Running results
```Python
Moby Dick; Or, The Whale
```
### read_infos(list) -> list
Pass a list and transmit the corresponding metadata values
``` Python
from epubedit import read_epub_info
book = read_epub_info("Moby Dick.epub")
print(book.get_infos(["book_name", "epub_version", "language"]))
```
Running results
```Python
{"book_name": "Moby Dick; Or, The Whale", "epub_version": "3.0", "language": "en"}
```
### read_all_infos() -> dict
No input value, all metadata information is transmitted. If there is a lack of relevant information in EPUB, it will return str: "" or list: []
``` Python
book = read_epub_info('Moby Dick.epub')
print(book.get_all_infos())
```
Running results
```Python
{
"epub_version": "3.0",
"rights": "Public domain in the USA.",
"book_name": "Moby Dick; Or, The Whale",
"author": ["Herman Melville"],
"isbn": "",
"asin": "",
"publisher": "",
"published_date": "",
"modified_date": "2024-07-20T22:24:39Z",
"language": "en",
"subject": [
"Whaling -- Fiction",
"Sea stories",
"Psychological fiction",
"Ship captains -- Fiction",
"Adventure stories",
"Mentally ill -- Fiction",
"Ahab, Captain (Fictitious character) -- Fiction",
"Whales -- Fiction",
"Whaling ships -- Fiction",
],
}
```
## Links
* **GitHub Repository :** [EpubEdit](https://github.com/childeyouyu/epubedit)
Raw data
{
"_id": null,
"home_page": null,
"name": "epubedit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "epub, ebook, metadata search, content.opf, ebook-reader, ebook-editor, epub-tools, digital-publishing, ebook-converter, ebook-management, ebook-library, metadata, metadata-editor, epub-metadata",
"author": "Youyu",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b2/41/bd88ae72d6ac18e5fdcaa4c2edcda8f342ffe72499bfd10b3ac410197063/epubedit-0.0.1.tar.gz",
"platform": null,
"description": "<!--\r\n * @Date: 2024-07-18 21:44:17\r\n * @LastEditors: youyu 2000601104@cjlu.edu.cn\r\n * @LastEditTime: 2024-07-22 23:47:12\r\n-->\r\n# EpubEdit\r\n\r\n> Regarding epubedit, this is a Python package for viewing and editing epub file metadata\r\n\r\n## Installation and Usage\r\n\r\n* Installation:\r\n\r\n``` Python\r\npip install epubedit\r\n```\r\n\r\n* Usage\r\n\r\n``` Python\r\n\r\nfrom epubedit import read_epub_info\r\n\r\n\r\nbook = read_epub_info('book_name')\r\nbook.get_infos()\r\n```\r\n\r\n## Functions\r\n\r\n### read_info(str) -> str | list\r\n\r\nRead the value of a single metadata\r\nSupported parameters:\r\n [\r\n 'epub_version',\r\n \"book_name\",\r\n \"author_name\",\r\n \"publisher_name\",\r\n \"ISBN\",\r\n \"ASIN\",\r\n \"bookid\",\r\n \"describe\",\r\n \"language\",\r\n \"rights\",\r\n \"publication_date\",\r\n ]\r\n\r\nExample:\r\n\r\n``` Python\r\nfrom epubedit import read_epub_info\r\n\r\nbook = read_epub_info(\"Moby Dick.epub\")\r\nprint(book.get_info('book_name'))\r\n```\r\n\r\nRunning results\r\n\r\n```Python\r\nMoby Dick; Or, The Whale\r\n```\r\n\r\n### read_infos(list) -> list\r\n\r\nPass a list and transmit the corresponding metadata values\r\n\r\n``` Python\r\nfrom epubedit import read_epub_info\r\n\r\nbook = read_epub_info(\"Moby Dick.epub\")\r\nprint(book.get_infos([\"book_name\", \"epub_version\", \"language\"]))\r\n```\r\n\r\nRunning results\r\n\r\n```Python\r\n{\"book_name\": \"Moby Dick; Or, The Whale\", \"epub_version\": \"3.0\", \"language\": \"en\"}\r\n```\r\n\r\n### read_all_infos() -> dict\r\n\r\nNo input value, all metadata information is transmitted. If there is a lack of relevant information in EPUB, it will return str: \"\" or list: []\r\n\r\n``` Python\r\nbook = read_epub_info('Moby Dick.epub')\r\nprint(book.get_all_infos())\r\n```\r\n\r\nRunning results\r\n\r\n```Python\r\n{\r\n \"epub_version\": \"3.0\",\r\n \"rights\": \"Public domain in the USA.\",\r\n \"book_name\": \"Moby Dick; Or, The Whale\",\r\n \"author\": [\"Herman Melville\"],\r\n \"isbn\": \"\",\r\n \"asin\": \"\",\r\n \"publisher\": \"\",\r\n \"published_date\": \"\",\r\n \"modified_date\": \"2024-07-20T22:24:39Z\",\r\n \"language\": \"en\",\r\n \"subject\": [\r\n \"Whaling -- Fiction\",\r\n \"Sea stories\",\r\n \"Psychological fiction\",\r\n \"Ship captains -- Fiction\",\r\n \"Adventure stories\",\r\n \"Mentally ill -- Fiction\",\r\n \"Ahab, Captain (Fictitious character) -- Fiction\",\r\n \"Whales -- Fiction\",\r\n \"Whaling ships -- Fiction\",\r\n ],\r\n}\r\n```\r\n\r\n## Links\r\n\r\n* **GitHub Repository :** [EpubEdit](https://github.com/childeyouyu/epubedit)\r\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "a python package to read ePub infos and edit it.",
"version": "0.0.1",
"project_urls": {
"homepage": "https://github.com/childeyouyu/epubedit",
"issues": "https://github.com/childeyouyu/epubedit/issues",
"repository": "https://github.com/childeyouyu/epubedit"
},
"split_keywords": [
"epub",
" ebook",
" metadata search",
" content.opf",
" ebook-reader",
" ebook-editor",
" epub-tools",
" digital-publishing",
" ebook-converter",
" ebook-management",
" ebook-library",
" metadata",
" metadata-editor",
" epub-metadata"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "579d1570dc0bd0b32655f7eb8b5ac6224a5ffd03c8b0c6d9cf8e42288efb6ea9",
"md5": "1fc3878dc8fe6aabf0a2f28744ac1748",
"sha256": "a536844c805ce8647ca0535b0ff9d835bd1062b0da14136ed03ededd5bb49b62"
},
"downloads": -1,
"filename": "epubedit-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1fc3878dc8fe6aabf0a2f28744ac1748",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 5340,
"upload_time": "2024-07-22T16:36:17",
"upload_time_iso_8601": "2024-07-22T16:36:17.520608Z",
"url": "https://files.pythonhosted.org/packages/57/9d/1570dc0bd0b32655f7eb8b5ac6224a5ffd03c8b0c6d9cf8e42288efb6ea9/epubedit-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b241bd88ae72d6ac18e5fdcaa4c2edcda8f342ffe72499bfd10b3ac410197063",
"md5": "180231f22ebbbc72affef6bf9d0334ce",
"sha256": "aa2200952d4ad94d83ea0265e4094997b9b2ca64780d1f2aeb71f1c99600cca8"
},
"downloads": -1,
"filename": "epubedit-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "180231f22ebbbc72affef6bf9d0334ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 4659,
"upload_time": "2024-07-22T16:36:19",
"upload_time_iso_8601": "2024-07-22T16:36:19.121571Z",
"url": "https://files.pythonhosted.org/packages/b2/41/bd88ae72d6ac18e5fdcaa4c2edcda8f342ffe72499bfd10b3ac410197063/epubedit-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 16:36:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "childeyouyu",
"github_project": "epubedit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "epubedit"
}
