From 450927631867d2cadb5a69166b0ccf3abc719aba Mon Sep 17 00:00:00 2001 From: Bryan Bailey Date: Fri, 1 Apr 2022 21:49:26 -0400 Subject: [PATCH] added testing for python 36 and 37; updated readme --- README.md | 38 ++++++++++++++++++++++++++++++++++---- static/comic.png | Bin 0 -> 3421 bytes tox.ini | 4 +++- 3 files changed, 37 insertions(+), 5 deletions(-) create mode 100644 static/comic.png diff --git a/README.md b/README.md index a89cc0f..5ae06a5 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +## 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/ +``` diff --git a/static/comic.png b/static/comic.png new file mode 100644 index 0000000000000000000000000000000000000000..6d7ca706e32a4e8da97badb02f9540fef4021b8f GIT binary patch literal 3421 zcmV-j4WjaiP)5tx5B`4031A5#I4gbT&4V-S2JQg* zlz&a}a4XR1qq1uFZ-~5kaE6UQWBJ!ro;siDCjuLQbCu8cB2w9@eD^TmiVEel1KWTe zpLH>X24wgg4)pc-`$1qKu&x@FX~EqU&8d*55m<${1TP29iL0_1<6_`WM5j`p;|X9& z+!YwF6#6bON;7XguvW?616&w=H8W2gA_&KE53L`Jv*2$k1wQ06|CLJqgOS$GJSO3u zLH!}l0v}Nd3)1DhO)daYavg96XRkWh&lmWaMhsNq@B1mJz#{K*MN%( z@de1U>MWTfAS-YV0YT=Uo6#Er?g36K<%J1L%9M2n&>LY{QG`z58)fRO@;fE}4Lw?JQFA-LIK1bwj{~NcU$q9Q7jI;c=heH3S(( zKwk7Mz@tioiJ(OA+&~-_|@<$@7?QfqrHIyKMhIjwmcqGfjyfJz+&aI=^FWZmALkM^&IC2)z7rXAR7i%+GvxRPnIt^``xHT^ogx3SrWfqG=; zbLKHc0CdK9Bd3F=2*7iQA{SI?Ka4%3@|PO#t2ow%g*#?LF;fH ze#xXBV5$Ig<23nx0QiWK<}~oUEj}7qBF+@13IGIK9?sk_V6p({jPaS*156fxZOCa{ zi&?l&1Z~23jC~F%@Y5S5CJO+_nE{LQkfUREdJ)5s#UN_yR8&Pw7l0tk!syObW??&V=m8DDCxBl9uPJ|PcPEdIwD}0CHXVo)3Tp~D1@Rel$d+a|a>96QAwB~+ zVeHpuk)1lkKhZp3KC0V=vZJ3a!-%NA;czd zbs;_hIbnPZdC}HOzs%$Nm*NzF<;afYNytg0W?*OdpAn2)0EAYYr-7S*-zaHXC<;Iw z(knDl*@v;}POk^K{3#XWI)I>K4|rOMkEi_0e;4>I@TCy-ik-X%5H=zwf-I*HUYkEQ z0FNWSjJ@bWRu8SQ{8hrcxr?1#0E9;5$`wlh1|xopRb}ihWW4?|;(U4+(t9)`JBg1) zP?rW|n25s>rwdaB-~yzT&o6{A%HQ|l{W3d&?-xQ;G$8uNd_sUd|pRzWH|@;&98V%S_y>kbRMxRVO2}g~Kt`CDQ^hjNR{Dpm}b6Fh%d`oA6V&dgL5n6VlRWpr^d`0RN)c%AcnOtbmX{0r(TLd|GO~{SAsQ zybY)G$Dr61$$7XPMwDVV($lmS{*7&}9w%uNfF7jfJqUab@yzi$#g`uR0x3H|l{dR0 z>7~5YBxw@>5Cv%|(HcJ{Ac|WP{*||95M?qdMKV>SQ2?S~C}Ll40&YV8ZUejWwi@r< zJDDOY0?-$+{8>}9$z)u4i;7wnfS}5o-3nN<%3D;_k^tDPfHwnIXy(hL@)i|o7XZ8R z=En+{dF3rC(kK88$n|vhB90q$=s>!2%L>>LPt~$V+615;F`atd?PtfngxicLaBO50qcQVN#||f zXA#GbtCFsW7g-SifTs!}#|LR^EuBjI{6uPzEb4DopGl;oO#swWw4X_&7Rj zH!As7XygISFRwOtl46GnRip#>JTV_tOQQhn1E%Bjux%R6z%;6`5jJf)fW>~qQQ|nn zqvr_HXXB5WZr~l@S)y@brA1l=z+xx0Vdbk?(l`XQpeovJ)o2Z7MZGqP@{y-GQ(IdFGG^~pN@(f527 z8R`&l7ICn2AF_~9js?i2OkUmBQbd2q@yBT7W)rVrRC@^UgDLhzIa)+)|wfxol!3?&A$GFO^nj1M_E`Hs^NW(^PJ)(~xdSwQZjP9w5dFXPAM&!?@Q? zzUSvl{3>#n0UL2&&~yOlzP(J6!;ooRxw4KUharyotdB0QAhQd5{YD`V@RFFyjFTbA zYO1RIZ9-h`pNg~ac{tbg{f3js?w@L}q%Bc?$La*?5NFtqtfu-Rh@!O?xxgvN@umI1 zd_*5;36MVw>aL@#>_R#V{1Lc@Dj%w?2X067g1yMx(@QcB11}*KKJ_;6xyah}n@G