mirror of
https://github.com/jo1gi/grawlix.git
synced 2026-04-11 11:11:28 -06:00
c2545b871f
- Fix config to load source configuration correctly - Add a newline in readme to be more readable
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# grawlix
|
|
|
|
|
|
|
|
[](https://ko-fi.com/jo1gi)
|
|
|
|
CLI ebook downloader
|
|
|
|
## Supported services
|
|
grawlix currently supports downloading from the following sources:
|
|
- [eReolen](https://ereolen.dk)
|
|
- [Flipp](https://flipp.dk)
|
|
- [Internet Archive](https://archive.org)
|
|
- [Manga Plus](https://mangaplus.shueisha.co.jp)
|
|
- [Royal Road](https://www.royalroad.com)
|
|
- [Saxo](https://saxo.com)
|
|
- [Webtoons](https://webtoons.com)
|
|
|
|
## Installation
|
|
```shell
|
|
git clone https://github.com/jo1gi/grawlix.git
|
|
cd grawlix
|
|
python3 setup.py install
|
|
```
|
|
|
|
## Authentication
|
|
Some sources require authentication, which can be done either with cli arguments
|
|
or a config file.
|
|
|
|
**Cli example**
|
|
```shell
|
|
grawlix --username "user@example.com" --password "SuperSecretPassword" <url>
|
|
```
|
|
|
|
**Config file example**
|
|
```toml
|
|
[sources.name]
|
|
username = "user@example.com"
|
|
password = "SuperSecretPassword"
|
|
```
|
|
|
|
## Download books
|
|
To download a book run:
|
|
```shell
|
|
grawlix [options] <book url>
|
|
```
|