# Noveldown
![Supported Python versions](https://img.shields.io/pypi/pyversions/noveldown)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Download from PyPI](https://img.shields.io/pypi/v/noveldown)](https://pypi.org/project/noveldown)
[![Download from the AUR](https://img.shields.io/aur/version/noveldown-git)](https://aur.archlinux.org/packages/noveldown-git)
[![Latest release](https://img.shields.io/github/v/release/potatoeggy/noveldown?display_name=tag)](https://github.com/potatoeggy/noveldown/releases/latest)
[![License](https://img.shields.io/github/license/potatoeggy/noveldown)](/LICENSE)
Webnovel downloader and converter to EPUB (with metadata!) as a Python library and command line application.
## Supported stories
To request a new story, please file a [new issue](https://github.com/potatoeggy/noveldown/issues/new).
- [The Wandering Inn](https://wanderinginn.com) - pirate aba
- [A Practical Guide to Evil](https://practicalguidetoevil.wordpress.com) - ErraticErrata
- [Pale](https://palewebserial.wordpress.com/) - Wildbow
## Installation
Install the package from PyPI:
```
pip3 install noveldown
```
Arch Linux users may also install the package from the [AUR](https://aur.archlinux.org/packages/noveldown-git.git):
```
git clone https://aur.archlinux.org/noveldown-git.git
makepkg -si
```
Or, to build from source:
Noveldown depends on [poetry](https://github.com/python-poetry/poetry) for building.
```
git clone https://github.com/potatoeggy/noveldown.git
poetry install
poetry build
pip3 install dist/noveldown*.whl
```
## Usage
To download the novel as an EPUB:
```
noveldown <ID>
# for example:
noveldown WanderingInn
```
IDs can be found through `noveldown --supported-ids`
Append the `--start` and `--end` options to limit the number of chapters downloaded.
Run `noveldown --help` for more info.
## Library Usage
```python
import noveldown
noveldown.download("WanderingInn", "./")
```
Raw data
{
"_id": null,
"home_page": "https://github.com/potatoeggy/noveldown",
"name": "noveldown",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "novel, epub, webnovel, download",
"author": "potatoeggy",
"author_email": "eggyrules@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/dd/13d04941e8957d44fe4f6287920fe1277d225f39a987d229bd11bc2c1ac5/noveldown-1.2.2.tar.gz",
"platform": null,
"description": "# Noveldown\n\n![Supported Python versions](https://img.shields.io/pypi/pyversions/noveldown)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n[![Download from PyPI](https://img.shields.io/pypi/v/noveldown)](https://pypi.org/project/noveldown)\n[![Download from the AUR](https://img.shields.io/aur/version/noveldown-git)](https://aur.archlinux.org/packages/noveldown-git)\n[![Latest release](https://img.shields.io/github/v/release/potatoeggy/noveldown?display_name=tag)](https://github.com/potatoeggy/noveldown/releases/latest)\n[![License](https://img.shields.io/github/license/potatoeggy/noveldown)](/LICENSE)\n\nWebnovel downloader and converter to EPUB (with metadata!) as a Python library and command line application.\n\n## Supported stories\n\nTo request a new story, please file a [new issue](https://github.com/potatoeggy/noveldown/issues/new).\n\n- [The Wandering Inn](https://wanderinginn.com) - pirate aba\n- [A Practical Guide to Evil](https://practicalguidetoevil.wordpress.com) - ErraticErrata\n- [Pale](https://palewebserial.wordpress.com/) - Wildbow\n\n## Installation\n\nInstall the package from PyPI:\n\n```\npip3 install noveldown\n```\n\nArch Linux users may also install the package from the [AUR](https://aur.archlinux.org/packages/noveldown-git.git):\n\n```\ngit clone https://aur.archlinux.org/noveldown-git.git\nmakepkg -si\n```\n\nOr, to build from source:\n\nNoveldown depends on [poetry](https://github.com/python-poetry/poetry) for building.\n\n```\ngit clone https://github.com/potatoeggy/noveldown.git\npoetry install\npoetry build\npip3 install dist/noveldown*.whl\n```\n\n## Usage\n\nTo download the novel as an EPUB:\n\n```\nnoveldown <ID>\n\n# for example:\nnoveldown WanderingInn\n```\n\nIDs can be found through `noveldown --supported-ids`\n\nAppend the `--start` and `--end` options to limit the number of chapters downloaded.\n\nRun `noveldown --help` for more info.\n\n## Library Usage\n```python\nimport noveldown\n\nnoveldown.download(\"WanderingInn\", \"./\")\n```\n",
"bugtrack_url": null,
"license": "LGPL-3.0-only",
"summary": "Webnovel downloader and EPUB converter",
"version": "1.2.2",
"project_urls": {
"Documentation": "https://github.com/potatoeggy/noveldown",
"Homepage": "https://github.com/potatoeggy/noveldown",
"Repository": "https://github.com/potatoeggy/noveldown"
},
"split_keywords": [
"novel",
" epub",
" webnovel",
" download"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "22d629d204b07a62bbceec39b998fb879f93de13793b95d8c1d948ec72f5c68c",
"md5": "52ae6b9ecd3ef51426295e2807912a14",
"sha256": "a2d2df77a1beb4c7f5e7fcf51ef6725f99642c3ac82a573bcda0eedee64b23ed"
},
"downloads": -1,
"filename": "noveldown-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52ae6b9ecd3ef51426295e2807912a14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 15754,
"upload_time": "2024-04-12T14:37:40",
"upload_time_iso_8601": "2024-04-12T14:37:40.257665Z",
"url": "https://files.pythonhosted.org/packages/22/d6/29d204b07a62bbceec39b998fb879f93de13793b95d8c1d948ec72f5c68c/noveldown-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31dd13d04941e8957d44fe4f6287920fe1277d225f39a987d229bd11bc2c1ac5",
"md5": "3634f47e6b6ad4418f1c36798c1cefa8",
"sha256": "3c83064047860202835b5c22a0b5645e223d3dd8b964277208a51592b9a306f9"
},
"downloads": -1,
"filename": "noveldown-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "3634f47e6b6ad4418f1c36798c1cefa8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 12842,
"upload_time": "2024-04-12T14:37:41",
"upload_time_iso_8601": "2024-04-12T14:37:41.646735Z",
"url": "https://files.pythonhosted.org/packages/31/dd/13d04941e8957d44fe4f6287920fe1277d225f39a987d229bd11bc2c1ac5/noveldown-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 14:37:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "potatoeggy",
"github_project": "noveldown",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "noveldown"
}