The Internet Archive Python Library#

Release v5.7.3.dev0. (Installation)

tox versions downloads contributors

Welcome to the documentation for the internetarchive Python library. This tool provides both a command-line interface (CLI) and a Python API for interacting with archive.org, allowing you to search, download, upload and interact with archive.org services from your terminal or in Python.

These docs guide you through installation, usage, and examples, whether you’re new to Python, just want to try the CLI, or are building applications that work with the Internet Archive. Please report any issues or contribute on GitHub.

Quick start#

If you’re new to Python or the command line interface (CLI), the easiest way to get started is to follow these three steps:

  1. Download a binary of the ia command-line tool

  2. Configure your environment with your Archive.org credentials

  3. Visit the CLI documentation to start exploring how to use the tool

Documentation#

For more detailed information, including installing the command-line tool and Python library, please refer to the following sections:

Setup & Configuration#

Get the tools running on your system:

User Interfaces#

These are the main ways to use the Internet Archive Python Library and CLI:

Performance & Scaling#

Optimize your workflows:

Development & Community#

Contribute and stay updated:

Help & Support#

Get help when you need it:

  • Documentation: Check this troubleshooting guide first

  • Community: Search existing GitHub Issues

  • Report: If you can’t find a solution, open a new issue

When reporting an issue, please include:

  • The exact command or code that caused the problem

  • Any error messages you received

  • Your operating system and Python version

Before reporting, make sure you’re using the latest version of the library and Updating if necessary.

Reference#

Complete reference documentation for all modules:

Authors#

Indices and tables#