| Name | grawlix JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | CLI tool for downloading ebooks |
| upload_time | 2024-01-15 14:25:46 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | |
| keywords |
ebook
cli
downloader
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# grawlix
[](https://ko-fi.com/jo1gi)
CLI ebook downloader
## Supported services
grawlix currently supports downloading from the following sources:
- [DC Universe Infinite](https://www.dcuniverseinfinite.com)
- [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>
```
Raw data
{
"_id": null,
"home_page": "",
"name": "grawlix",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ebook,cli,downloader",
"author": "",
"author_email": "Joakim Holm <mail@joakimholm.xyz>",
"download_url": "https://files.pythonhosted.org/packages/dd/64/86a226c253a3cd0b6d1e529011bf6449b5bcd0355a45fb336843eb5b47bf/grawlix-0.2.0.tar.gz",
"platform": null,
"description": "# grawlix\n\n\n\n[](https://ko-fi.com/jo1gi)\n\nCLI ebook downloader\n\n## Supported services\ngrawlix currently supports downloading from the following sources:\n- [DC Universe Infinite](https://www.dcuniverseinfinite.com)\n- [eReolen](https://ereolen.dk)\n- [fanfiction.net](https://www.fanfiction.net)\n- [Flipp](https://flipp.dk)\n- [Internet Archive](https://archive.org)\n- [Manga Plus](https://mangaplus.shueisha.co.jp)\n- [Marvel Unlimited](https://marvel.com)\n- [Nextory](https://nextory.com)\n- [Royal Road](https://www.royalroad.com)\n- [Saxo](https://saxo.com)\n- [Webtoons](https://webtoons.com)\n\n## Installation\n\n### From pypi (recommended)\n```shell\npip install grawlix\n```\n\n### From repo (unstable)\n```shell\ngit clone https://github.com/jo1gi/grawlix.git\ncd grawlix\npython3 setup.py install\n```\n\n## Authentication\nAuthentication can either be done with login (username and password) or cookies.\nNot all sources support both methods.\n\n### Login\nSome sources require authentication, which can be done either with cli arguments\nor a config file.\n\n**Cli example**\n```shell\ngrawlix --username \"user@example.com\" --password \"SuperSecretPassword\" <url>\n```\n\n**Config file example**\n```toml\n[sources.name]\nusername = \"user@example.com\"\npassword = \"SuperSecretPassword\"\n```\nConfig file should be placed in `~/.config/grawlix/grawlix.toml`\n\n### Cookies\nSome sources can be authenticated with Netscape cookie files. I use\n[this extension](https://github,com/rotemdan/ExportCookies) to export my\ncookies from my browser.\n\nCookies can be placed in current dir as `cookies.txt` or be given with the\n`--cookie` argument.\n\n## Download books\nTo download a book run:\n```shell\ngrawlix [options] <book url>\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "CLI tool for downloading ebooks",
"version": "0.2.0",
"project_urls": {
"Bugtracker": "https://github.com/jo1gi/grawlix/issues",
"Homepage": "https://github.com/jo1gi/grawlix"
},
"split_keywords": [
"ebook",
"cli",
"downloader"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e49adedb2717fea90cd3765501457f2e0c305e9ec372c14b911e27e1279a6b32",
"md5": "00fd728b99dc5a98e464028f576e2411",
"sha256": "4caf6a1b21d44c255246d525f8ea1f4ada24abaf3b9a0f3d6f913052fb13bb07"
},
"downloads": -1,
"filename": "grawlix-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00fd728b99dc5a98e464028f576e2411",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 48676,
"upload_time": "2024-01-15T14:25:45",
"upload_time_iso_8601": "2024-01-15T14:25:45.149940Z",
"url": "https://files.pythonhosted.org/packages/e4/9a/dedb2717fea90cd3765501457f2e0c305e9ec372c14b911e27e1279a6b32/grawlix-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd6486a226c253a3cd0b6d1e529011bf6449b5bcd0355a45fb336843eb5b47bf",
"md5": "efcb8fad6b97085d260f7e1588937520",
"sha256": "1ca2b9b6d905079bdce48b086e6d7a6e2935b0992c3ebf19cb5d6b53cd429348"
},
"downloads": -1,
"filename": "grawlix-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "efcb8fad6b97085d260f7e1588937520",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38643,
"upload_time": "2024-01-15T14:25:46",
"upload_time_iso_8601": "2024-01-15T14:25:46.762296Z",
"url": "https://files.pythonhosted.org/packages/dd/64/86a226c253a3cd0b6d1e529011bf6449b5bcd0355a45fb336843eb5b47bf/grawlix-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 14:25:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jo1gi",
"github_project": "grawlix",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "grawlix"
}
