Initial commit of Yiffer CLI scraper (Termux compatible) with CBZ support
This commit is contained in:
66
README.md
Normal file
66
README.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# Yiffer Scraper
|
||||
|
||||
A pure Python scraper to download comics from yiffer.xyz, automatically packing them into `.cbz` files.
|
||||
|
||||
It is completely written using Python's standard library, meaning it works out-of-the-box anywhere Python 3 is installed—including on Android via Termux!
|
||||
|
||||
## Features
|
||||
- **Browse & Search:** Search for comics directly from the terminal.
|
||||
- **Concurrent Downloads:** Download pages in parallel.
|
||||
- **CBZ Export:** Packages downloads directly into CBZ format.
|
||||
- **Termux Compatible:** Requires zero third-party packages (no `pip install requests` necessary).
|
||||
|
||||
## Installation & Usage (All Platforms)
|
||||
|
||||
You only need Python 3 installed. If you're on Linux, macOS, or Windows, simply download `yiffer_scraper.py` and run it:
|
||||
|
||||
```bash
|
||||
python3 yiffer_scraper.py browse
|
||||
python3 yiffer_scraper.py download "Comic Name"
|
||||
```
|
||||
|
||||
## Termux Setup (Android)
|
||||
|
||||
If you are using Termux on Android, setup is extremely simple:
|
||||
|
||||
1. Install Python:
|
||||
```bash
|
||||
pkg update && pkg install python -y
|
||||
```
|
||||
|
||||
2. Make the script executable:
|
||||
```bash
|
||||
chmod +x yiffer_scraper.py
|
||||
```
|
||||
|
||||
3. Run the script:
|
||||
```bash
|
||||
./yiffer_scraper.py --help
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
### Browse
|
||||
View the latest comics on the site:
|
||||
```bash
|
||||
./yiffer_scraper.py browse
|
||||
./yiffer_scraper.py browse --page 2
|
||||
```
|
||||
|
||||
### Search
|
||||
Search for specific comics:
|
||||
```bash
|
||||
./yiffer_scraper.py browse --search "Bifurcation"
|
||||
```
|
||||
|
||||
### Download
|
||||
Download a specific comic by exact name:
|
||||
```bash
|
||||
./yiffer_scraper.py download "Bifurcation" --output ./my_comics
|
||||
```
|
||||
|
||||
### Download Recent (Bulk)
|
||||
Download the latest `N` comics from the homepage automatically:
|
||||
```bash
|
||||
./yiffer_scraper.py download-recent --count 10 --output ./my_comics
|
||||
```
|
||||
Reference in New Issue
Block a user