# Web Novel Scraper CLI
## 🔑 Why Use Web Novel Scraper?
- **Read Offline**: Download your favorite novels and read them anywhere, even without internet
- **Device Friendly**: EPUB format optimized for e-readers and mobile devices
- **Resource Efficient**: Smart caching system prevents unnecessary downloads
- **Server Friendly**: Prevents accidental server overloads
- **Simple Interface**: Basic and direct commands for a hassle-free experience
- **Automatic Organization**: Keep your novels organized and easy to find
## 🌟 Main Features
- Downloads and converts web novels to EPUB format
- Smart caching: downloads chapters only once
- Simple and straightforward command-line interface
- Support for multiple web novel sites
## 🚀 Quick Tutorial
### 1. Installation
``` bash
pip install web-novel-scraper
```
### 2. Download Your First Novel
1. **Create a new novel**:
``` bash
web-novel-scraper create-novel -t "My First Novel" --toc-main-url "https://novelbin.me/novel/my-novel/toc"
```
2. **Convert to EPUB**:
``` bash
web-novel-scraper save-novel-to-epub -t "My First Novel" --sync-toc
```
3. **Find your files**:
``` bash
web-novel-scraper show-novel-dir -t "My First Novel"
```
### 3. Additional Options
- **Add metadata**:
``` bash
web-novel-scraper set-metadata -t "My First Novel" --author "Author" --language "en"
```
- **Add cover image**:
``` bash
web-novel-scraper set-cover-image -t "My First Novel" --cover "path/to/image.jpg"
```
- **View novel information**:
``` bash
web-novel-scraper show-novel-info -t "My First Novel"
```
## 📱 Supported Sites
- Novelbin
- Novelhi
- Novellive
- Royalroad
- GenesisStudio
- HostedNovel
- ScribbleHub
- NovelCool
- FreeWebNovel
- Foxaholic
- Fanmtl
- Pandamtl
- MtlNovels
## 📖 Full Documentation
For a detailed guide, advanced use cases, and complete command reference, visit:
[https://web-novel-scraper.readthedocs.io/stable/](https://web-novel-scraper.readthedocs.io/stable/)
## 📝 Responsible Usage Note
Please use this tool responsibly and respect the terms of service and rate limits of the web novel sites.
Raw data
{
"_id": null,
"home_page": null,
"name": "web-novel-scraper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Novel Downloader, Scraper, Web Novel, Web Novel Downloader, Web Novel Scraper",
"author": null,
"author_email": "ImagineBrkr <salvattore_25@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3f/36/8ecafec881128c444b793dfe95960a74bc6235a2799fd1f5c273a4a03fdf/web_novel_scraper-2.1.12.tar.gz",
"platform": null,
"description": "# Web Novel Scraper CLI\n\n## \ud83d\udd11 Why Use Web Novel Scraper?\n\n- **Read Offline**: Download your favorite novels and read them anywhere, even without internet\n- **Device Friendly**: EPUB format optimized for e-readers and mobile devices\n- **Resource Efficient**: Smart caching system prevents unnecessary downloads\n- **Server Friendly**: Prevents accidental server overloads\n- **Simple Interface**: Basic and direct commands for a hassle-free experience\n- **Automatic Organization**: Keep your novels organized and easy to find\n\n## \ud83c\udf1f Main Features\n\n- Downloads and converts web novels to EPUB format\n- Smart caching: downloads chapters only once\n- Simple and straightforward command-line interface\n- Support for multiple web novel sites\n\n## \ud83d\ude80 Quick Tutorial\n\n### 1. Installation\n``` bash\npip install web-novel-scraper\n```\n### 2. Download Your First Novel\n\n1. **Create a new novel**:\n``` bash\nweb-novel-scraper create-novel -t \"My First Novel\" --toc-main-url \"https://novelbin.me/novel/my-novel/toc\"\n```\n2. **Convert to EPUB**:\n``` bash\nweb-novel-scraper save-novel-to-epub -t \"My First Novel\" --sync-toc\n```\n3. **Find your files**:\n``` bash\nweb-novel-scraper show-novel-dir -t \"My First Novel\"\n```\n### 3. Additional Options\n\n- **Add metadata**:\n``` bash\nweb-novel-scraper set-metadata -t \"My First Novel\" --author \"Author\" --language \"en\"\n```\n- **Add cover image**:\n``` bash\nweb-novel-scraper set-cover-image -t \"My First Novel\" --cover \"path/to/image.jpg\"\n```\n- **View novel information**:\n``` bash\nweb-novel-scraper show-novel-info -t \"My First Novel\"\n```\n## \ud83d\udcf1 Supported Sites\n\n- Novelbin\n- Novelhi\n- Novellive\n- Royalroad\n- GenesisStudio\n- HostedNovel\n- ScribbleHub\n- NovelCool\n- FreeWebNovel\n- Foxaholic\n- Fanmtl\n- Pandamtl\n- MtlNovels\n\n## \ud83d\udcd6 Full Documentation\n\nFor a detailed guide, advanced use cases, and complete command reference, visit:\n[https://web-novel-scraper.readthedocs.io/stable/](https://web-novel-scraper.readthedocs.io/stable/)\n\n## \ud83d\udcdd Responsible Usage Note\n\nPlease use this tool responsibly and respect the terms of service and rate limits of the web novel sites.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python tool that allows you to scrape web novels from various sources and save them to more readable formats like EPUB.",
"version": "2.1.12",
"project_urls": {
"Documentation": "https://web-novel-scraper.readthedocs.io",
"Homepage": "https://github.com/ImagineBrkr/web-novel-scraper",
"Repository": "https://github.com/ImagineBrkr/web-novel-scraper.git"
},
"split_keywords": [
"novel downloader",
" scraper",
" web novel",
" web novel downloader",
" web novel scraper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "52f8e62586870b7957ca4c736ac84cc765aa9d937b1ae8c0a990926a118ff4fe",
"md5": "ff5725c807040b6871dbe87886ba07f1",
"sha256": "d1a8c436cd8478ee7ef8c1304fa7f697eca8c00f82a09498aa2894681ddf49f6"
},
"downloads": -1,
"filename": "web_novel_scraper-2.1.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff5725c807040b6871dbe87886ba07f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 40360,
"upload_time": "2025-07-20T01:49:57",
"upload_time_iso_8601": "2025-07-20T01:49:57.053630Z",
"url": "https://files.pythonhosted.org/packages/52/f8/e62586870b7957ca4c736ac84cc765aa9d937b1ae8c0a990926a118ff4fe/web_novel_scraper-2.1.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3f368ecafec881128c444b793dfe95960a74bc6235a2799fd1f5c273a4a03fdf",
"md5": "cae17ad667be89e56651518f1c9cc971",
"sha256": "425b683d28dac7fc1dffbf3b03ce5e5a30bf8069554a98433600855a0573e670"
},
"downloads": -1,
"filename": "web_novel_scraper-2.1.12.tar.gz",
"has_sig": false,
"md5_digest": "cae17ad667be89e56651518f1c9cc971",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 42608,
"upload_time": "2025-07-20T01:49:58",
"upload_time_iso_8601": "2025-07-20T01:49:58.584783Z",
"url": "https://files.pythonhosted.org/packages/3f/36/8ecafec881128c444b793dfe95960a74bc6235a2799fd1f5c273a4a03fdf/web_novel_scraper-2.1.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-20 01:49:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ImagineBrkr",
"github_project": "web-novel-scraper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "bs4",
"specs": [
[
"==",
"0.0.2"
]
]
},
{
"name": "ebooklib",
"specs": [
[
"==",
"0.18"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.8"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"4.3.6"
]
]
},
{
"name": "dataclasses_json",
"specs": [
[
"==",
"0.6.7"
]
]
},
{
"name": "ftfy",
"specs": [
[
"==",
"6.3.1"
]
]
}
],
"lcname": "web-novel-scraper"
}
JSON
