Installation & Usage - TheNamesArthur/rulescrape GitHub Wiki

Installation

Option 1: Compiled Executable (Recommended for End Users)

Requirements

• Windows or Linux
• No Python installation needed

Steps

1. Download the compiled executable for your platform (or build it yourself using PyInstaller).
2. Place the executable in your desired image directory for convenience.
3. Run it:
   • Double-click the file
   • Or launch via terminal:

     ./dist/rulescrape
     

---

Option 2: Python Source (For Developers and Power Users)

Requirements

• Python 3.13+
• Recommended: Virtual environment

Steps

1. Install dependencies:

   python -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt
   

   If requirements.txt is missing, install manually:

   pip install requests tqdm
   

2. Run the script:

   python rulescrape.py
   

---

Usage

GUI Mode

• Launch the program:

  ./rulescrape              # If using the compiled executable
  python rulescrape.py      # If running from source
  

• Set options such as booru type, tags, download limit, organization method, and skin from the interface.
• Click the download button to begin. Progress and any errors are shown in the window.
• Press Ctrl+S to cycle through available skins.

---

CLI Mode

Available only when using the Python source (not the compiled executable).

Use terminal arguments to fully control the application:

python rulescrape.py \
  --booru_type rule34 \
  --tag "1boy" \
  --limit 20 \
  --anti_ai true \
  --multithread \
  --org_method "By extension only"

• All CLI-supplied settings are saved and persist across GUI launches.

---