Name | grawlix JSON |
Version |
0.2.1
JSON |
| download |
home_page | None |
Summary | CLI tool for downloading ebooks |
upload_time | 2024-10-30 17:02:39 |
maintainer | None |
docs_url | None |
author | None |
requires_python | None |
license | None |
keywords |
ebook
cli
downloader
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# grawlix
![GitHub release](https://img.shields.io/github/v/release/jo1gi/grawlix)
![GitHub top language](https://img.shields.io/github/languages/top/jo1gi/grawlix)
![License](https://img.shields.io/github/license/jo1gi/grawlix)
[![Donate using Ko-Fi](https://img.shields.io/badge/donate-kofi-00b9fe?logo=ko-fi&logoColor=00b9fe)](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)
- [Storytel / Mofibo](http://storytel.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": null,
"name": "grawlix",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ebook, cli, downloader",
"author": null,
"author_email": "Joakim Holm <mail@joakimholm.xyz>",
"download_url": "https://files.pythonhosted.org/packages/86/41/7089681f04b5f2e8dfbc7bf887c5abe223b30b0c9d9be4425faeab2be523/grawlix-0.2.1.tar.gz",
"platform": null,
"description": "# grawlix\n![GitHub release](https://img.shields.io/github/v/release/jo1gi/grawlix)\n![GitHub top language](https://img.shields.io/github/languages/top/jo1gi/grawlix)\n![License](https://img.shields.io/github/license/jo1gi/grawlix)\n[![Donate using Ko-Fi](https://img.shields.io/badge/donate-kofi-00b9fe?logo=ko-fi&logoColor=00b9fe)](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- [Storytel / Mofibo](http://storytel.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": null,
"summary": "CLI tool for downloading ebooks",
"version": "0.2.1",
"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": "528cd0186de59225fa4b715381d4be026deaf1b02410a6fb8eaef92bd32a3d00",
"md5": "9d8d011af0e5562936a8fcc0ef8e7fc1",
"sha256": "cdafe79cd2a3d86bc75d365bb05352618fd0a75c64291d1d07fa3ef005d992c8"
},
"downloads": -1,
"filename": "grawlix-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d8d011af0e5562936a8fcc0ef8e7fc1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 51629,
"upload_time": "2024-10-30T17:02:37",
"upload_time_iso_8601": "2024-10-30T17:02:37.818665Z",
"url": "https://files.pythonhosted.org/packages/52/8c/d0186de59225fa4b715381d4be026deaf1b02410a6fb8eaef92bd32a3d00/grawlix-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86417089681f04b5f2e8dfbc7bf887c5abe223b30b0c9d9be4425faeab2be523",
"md5": "e0c47e167d15e53b4d924e2e64e6bf92",
"sha256": "a5e1152cf97ac294331cff2e9369eef1868095543b30fe65425d047d2c421606"
},
"downloads": -1,
"filename": "grawlix-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "e0c47e167d15e53b4d924e2e64e6bf92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40793,
"upload_time": "2024-10-30T17:02:39",
"upload_time_iso_8601": "2024-10-30T17:02:39.554037Z",
"url": "https://files.pythonhosted.org/packages/86/41/7089681f04b5f2e8dfbc7bf887c5abe223b30b0c9d9be4425faeab2be523/grawlix-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 17:02:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jo1gi",
"github_project": "grawlix",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "grawlix"
}