R34Sch - Rule 34 CLI

r34sch is a cli utility for downloading rule 34 content (rule34.xxx) to your device. (Windows, Linux and Android (Termux))

Installation

PIP

R34Sch is now available through the pip package manager, simply type:

pip install r34sch

Building from source

1. Clone the repository:

git clone https://github.com/giudehx/r34sch

2. Go to the r34sch directory:

cd r34sch

3. Install dependencies:

python -m pip install --upgrade build

4. Build:

python -m build

5. Install:

pip install -e .

Configuring

You need to have a r34sch.cfg file, containing the Rule34.xxx API Key and User ID.

The format of the config file is this:

api_key=<YOUR_API_KEY>
user_id=<YOUR_USER_ID>

To get the API Key (and User ID) (skip 1 and 2 if you are already logged in):

1. Go to https://rule34.xxx and click on My Account
2. Click Sign Up and create an account, or click Login if you have an account
3. Once logged in, click Options, scroll down until you see API Access Credentials
4. Check the box that says Generate New Key?, then click Save at the bottom of the page.
5. Now scroll to API Access Credentials again, and you'll see the API Key in plain text. Do not close the browser.

It should look like this: this is just an example lookalike

&api_key=abc123...&user_id=xxxxxx

Now how to configure R34Sch?

1. Create a new file, it has to be exactly named r34sch.cfg
2. At the settings page of rule 34 copy the value after &api_key=. Do not copy &user_id= and the value that comes after it, stop at the ampersand (&)
3. At the r34sch.cfg file, type: api_key= as the first thing, then after the equal sign paste the api key. Do not save the file yet.
4. Go to the settings page of rule 34 copy the value after &user_id=.
5. At the config file again type: user_id=, then after the equal sign paste the user id. The .cfg file now should look like this:

api_key=<YOUR_API_KEY>
user_id=<YOUR_USER_ID>

6. Save the file.
7. Type:

r34sch --load-config

If it errors because it couldn't find r34sch.cfg, make sure that the file you just saved should be exactly named (both filename and extension): r34sch.cfg. Then try again, make sure to run it exactly the same directory as the config file.

Using R34Sch

To run R34Sch, type:

r34sch

Then you insert a prompt between quotes:

r34sch "example"

Or options:

r34sch "example" <options>

Here's the available options:

  -h, --help            show this help message and exit
  -n, --number NUMBER   The number of images to download.
  -i, --info            Get the information of a post (if -I is passed) or posts instead of downloading
  -v, --verbose         Enable verbosity, basically more output when executing
  -p, --page PAGE       Tell the program what page to search
  -t, --thumbnail       Only download the thumbnail instead of the post image, helps speed the program
  -o, --output OUTPUT   Where the images will be downloaded, default is 'r34_out'
  -T, --tag-search      Search the type, count (n. posts) and id of a tag
  -q, --quiet           Disables output when running R34Sch.
  -I, --id              Download from an ID.
  -r, --rating RATING   Filter posts by rating, options are: safe, questionable and explicit, can also be combined but have to be seperated by commas.
                        (safe,questionable; explicit,safe ...)
  -e, --extension EXTENSION
                        Filter posts by extension, options are: png, jpg, jpeg, gif & mp4, can also be combined but have to be seperated by commas. (mp4,gif;
                        png,jpeg,jpg; gif,png ...)
  -s, --search          Search for posts instead of downloading.
  --no-write            Disable writing an archive after downloading
  --load-config         Load the configuration file: r34sch.cfg, basically required, for more information read the README.md file
  --exclude-ai          Filter AI posts. Rejects a post from downloading if in one of its tags containes 'ai_'.
  -R, --random          Randomize posts.
  --only-image          Retrieve only images
  --only-video          Retrieve only videos
  -c, --clear-cache     Clear the cache folder.
  -l, --list-cache      View the currently cached/archived downloads.
  -d, --delete DELETE   Delete a specific cache/archive, please do -l or --list-cache first

Examples

To download something, type:

r34sch "<someone>" -n <number of posts to download> -o <output folder>

Or from an ID:

r34sch -I "<id>" -o <output folder>

To search for a name (and posts):

r34sch -s "<someone>"

To exclude AI posts/slopwork artwork:

r34sch --exclude-ai "<someone>" <other arguments...>

But if you want to get the Information of a post/posts:

r34sch -i "<someone>" -n <number of posts> # NO ID

r34sch -I -i "<id>" # WITH ID

If your network is too shitty:

r34sch -t "<someone>" -n <number of posts to download> -o <output folder>

If you want to filter only SAFE posts:

r34sch -r safe "<someone>" -n <number of posts to download> -o <output folder>

... or other ratings:

r34sch -r questionable,explicit "<someone>" -n <number of posts to download> -o <output folder>

To filter for specific file extensions (available png, jpg & jpeg, gif, mp4):

r34sch -e <extensions> "<someone>" -n <number of posts to download> -o <output folder>

For filtering only images or videos, pass --only-image or --only-video, don't pass them toghether :'D

Note: if using termux, and you didnt specify -o to be -o /sdcard/..., to view the content type termux-setup-storage it should be available on the default android file browser by clicking the top-left corner and scrolling down until you spot 'termux'

Notes

This is a very work in progress, later we'll add improvements such as different sites, multitasking as well.