bryan/yoink
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added testing for python 36 and 37; updated readme

Browse Source
This commit is contained in:
Bryan Bailey
2022-04-01 21:49:26 -04:00
parent d71a8db95c
commit 4509276318
3 changed files with 37 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -1,7 +1,37 @@
# yoink
# Yo!nk
[![wakatime](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink.svg)](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink)
[![wakatime](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink.svg)](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink) [![Tests](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.svg)](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.sv)
[![Tests](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.svg)](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.sv)
Yo!nk is a multi-site media download tool that scrapes comic images from online aggragate sites like [readallcomics.com](http://readallcomics.com) and [dragonballsupermanga.net](https://dragonballsupermanga.net/) compressing them into a ```.cbr``` archive. Magnet links support from ```tpb.party``` coming soon.
Yoink! is a multisite media download tool. It scrapes comics from online comic aggragate sites like ```readallcomics.com``` and ```dragonballsupermanga.net``` compressing them into a .cbr archive. Magnet links support from ```tpb.party``` coming soon.
## Supported Sites
| Name | URL |
|------|-----|
| readallcomics | [http://readallcomics.com](http://readallcomics.com) |
| dragonballsupermanga | [https://dragonballsupermanga.net/](https://dragonballsupermanga.net/) |
| mangadex | [https://www.mangadex.tv](https://www.mangadex.tv) |
## Installing/Getting Started
Navigate to the downloaded folder & install using pip
```shell
pip install -e .
```
## Usage
Downloaded archives will appear in ```$HOME/yoink/library/comics``` unless otherwise specified in a ```yoink.json``` config file. Yoink will look both in the root of the program folder or in ```$HOME/.config/yoink``` before defaulting to a preconfigured dict.
### You can download a single comic issue
```shell
yoink http://readallcomics.com/static-season-one-6-2022/
```
### Or an entire series from a starting point
```shell
yoink -s http://readallcomics.com/static-season-one-6-2022/
```