mirror of
https://github.com/jo1gi/grawlix.git
synced 2025-12-23 06:56:24 +00:00
70 lines
1.9 KiB
Markdown
70 lines
1.9 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)
|
|
- [fanfiction.net](https://www.fanfiction.net)
|
|
- [Flipp](https://flipp.dk)
|
|
- [Internet Archive](https://archive.org)
|
|
- [Manga Plus](https://mangaplus.shueisha.co.jp)
|
|
- [Marvel Unlimited](https://marvel.com)
|
|
- [Nextory](https://nextory.com)
|
|
- [Royal Road](https://www.royalroad.com)
|
|
- [Saxo](https://saxo.com)
|
|
- [Webtoons](https://webtoons.com)
|
|
|
|
## Installation
|
|
|
|
### From pypi (recommended)
|
|
```shell
|
|
pip install grawlix
|
|
```
|
|
|
|
### From repo (unstable)
|
|
```shell
|
|
git clone https://github.com/jo1gi/grawlix.git
|
|
cd grawlix
|
|
python3 setup.py install
|
|
```
|
|
|
|
## Authentication
|
|
Authentication can either be done with login (username and password) or cookies.
|
|
Not all sources support both methods.
|
|
|
|
### Login
|
|
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"
|
|
```
|
|
Config file should be placed in `~/.config/grawlix/grawlix.toml`
|
|
|
|
### Cookies
|
|
Some sources can be authenticated with Netscape cookie files. I use
|
|
[this extension](https://github,com/rotemdan/ExportCookies) to export my
|
|
cookies from my browser.
|
|
|
|
Cookies can be placed in current dir as `cookies.txt` or be given with the
|
|
`--cookie` argument.
|
|
|
|
## Download books
|
|
To download a book run:
|
|
```shell
|
|
grawlix [options] <book url>
|
|
```
|