Metadata-Version: 2.1
Name: noveldown
Version: 1.0.1
Summary: Command line application and library to download webnovels
Home-page: https://github.com/potatoeggy/noveldown
License: LGPL-3.0-only
Keywords: novel,epub,webnovel,download
Author: Daniel Chen
Author-email: danielchen04@hotmail.ca
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: EbookLib (>=0.17.1,<0.18.0)
Requires-Dist: beautifulsoup4 (>=4.10.0,<5.0.0)
Requires-Dist: lxml (>=4.8.0,<5.0.0)
Requires-Dist: requests (>=2.27.1,<3.0.0)
Requires-Dist: typer (>=0.5.0,<0.6.0)
Project-URL: Documentation, https://github.com/potatoeggy/noveldown
Project-URL: Repository, https://github.com/potatoeggy/noveldown
Description-Content-Type: text/markdown

# 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

## 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 get <ID>

# for example:
noveldown get 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", "./")
```

