About itchio

itchiodl is a command-line utility designed to download games and assets from the Itch.io platform. Formerly known as pithub, the package was renamed to avoid PyPI conflicts. It leverages the same application programming interface used by the official Itch.io desktop client to retrieve files from a user's library or bundle pages. The tool supports headless operation via the Python module or setup tools entry point. Key features include the ability to perform concurrent downloads to speed up the process, specifying operating system preferences such as macOS or cross-platform builds, and organizing output into human-readable folder structures based on publisher and game titles. Users with two-factor authentication must generate an API key for secure access. The software also includes a bundle addition tool that automates the process of adding items from a bundle URL to a user's library without downloading the actual files. The system handles download failures gracefully by logging specific error details, such a

e

Published by

emersont1

Visit View Profile

README.md

View on GitHub

IMPORTANT NOTICE: up until 2022-03-09, the package was called itchio, it is now called itchiodl (to avoid pypi conflicts)

Itchio Downloader Tool

Install

pip install itchiodl

Download All Games in library from account

Please Note: Having too many jobs may cause rate-limiting from some testing 8 works fine but 10 starts giving errors.

# via python
python -m itchiodl.downloader

# via setup-tools entry point
itch-download

This uses the same API the itchio app uses to download the files. If you have 2FA enabled, generate an API key here and run the following instead

# via python (with 4 concurrent downloads)
python -m itchiodl.downloader --api-key=KEYHERE --jobs=4

# via setup-tools entry point
itch-download -k KEYHERE

# download with multiple threads
itch-download -k KEYHERE -j 4

# only download osx or cross platform downloads
itch-download -p osx

# folder structure uses display names for users/publishers and game titles
itch-download --human-folders

Add All Games in a bundle to your library

# via python
python -m itchiodl.bundle_tool

# via setup-tools entry point
itch-load-bundle

This is a bit of a bodge, but it works. It essentially goes through and clicks the "Download" link on every item on the bundle's page, which adds it to your itchio library. It does not download any files. You will need the download page's URL (this will be in the bundle's email, and possibly your purchase history). It will not work with 2FA, and I'm unlikely to be able to fix it without making it far more complicated

Errors

if a download fails it will be reported in errors.txt in the same directory as your downloads

An example of which could look something like this:

Publisher Name: <Publisher Name>
Output File: <Publisher Name>/<Game Name>/<Specific Item>
Request URL: <Some URL>
Request Response Code: 404
Error Reason: Not Found
This game/asset has been skipped please download manually
---------------------------------------------------------

This is not a perfect solution but does prevent the whole process from crashing

itchio