.. internetarchive documentation master file, created by
   sphinx-quickstart on Mon Sep 23 20:16:03 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

The Internet Archive Python Library
===================================

Release v\ |version|. (:ref:`Installation <install>`)

|tox|
|versions|
|downloads|
|contributors|

.. |tox| image:: https://github.com/jjjake/internetarchive/actions/workflows/tox.yml/badge.svg
    :target: https://github.com/jjjake/internetarchive/actions/workflows/tox.yml

.. |versions| image:: https://img.shields.io/pypi/pyversions/internetarchive.svg
    :target: https://pypi.org/project/internetarchive

.. |downloads| image:: https://static.pepy.tech/badge/internetarchive/month
    :target: https://pepy.tech/project/internetarchive

.. |contributors| image:: https://img.shields.io/github/contributors/jjjake/internetarchive.svg
    :target: https://github.com/jjjake/internetarchive/graphs/contributors

Welcome to the documentation for the ``internetarchive`` Python library.
``internetarchive`` is a command-line and Python interface to archive.org.
Please report any issues on `Github <https://github.com/jjjake/internetarchive/issues>`__.

If you're not sure where to begin, the quickest and easiest way to get started is `downloading a binary <installation.html#binaries>`__ and taking a look at the `command-line interface documentation <cli.html>`__.


User's Guide
------------

.. toctree::
    :maxdepth: 2

    installation
    quickstart
    cli
    api
    updates
    parallel
    troubleshooting
    contributing
    authors
