Skip to main content

A CLI to download from archiveofourown.org

Project description

ao3-cli

A CLI to download from archiveofourown.org using their built-in download option.

To report issues for the CLI, open an issue at https://github.com/arzkar/ao3-cli/issues

Features:

  • Download works & series from archiveofourown.org
  • It also supports downloading all works or series from any archiveofourown.org page.

Installation

Using pip (Recommended)

pip install -U ao3-cli

From Source (Might have bugs, for development use)

pip install git+https://github.com/arzkar/ao3-cli@main

Usage

> ao3_cli
Usage: ao3_cli [OPTIONS]

  A CLI to download from archiveofourown.org

  To report issues for the CLI, open an issue at
  https://github.com/arzkar/ao3-cli/issues

Options:
  -u, --url TEXT       The url of the fanfiction enclosed within quotes
  -i, --infile TEXT    Give a filename to read URLs from
  -l, --list-url TEXT  Enter a comma separated list of urls to download,enclosed within quotes
  -o, --out-dir TEXT   Absolute path to the Output directory for files(default: Current Directory)
  -f, --format TEXT    Download Format: EPUB (default), AZW3, MOBI, PDF or HTML
  --force              Force overwrite of an existing file
  --get-urls TEXT      Get all story urls found from a page
  -d, --debug          Show the log in the console for debugging
  --log                Save the logfile for debugging
  -v, --version        Display version & quit.
  --help               Show this message and exit.

Example

  • To download using a URL
ao3_cli -u https://archiveofourown.org/works/10916730/chapters/24276864
  • To download using a file containing URLs
ao3_cli -i urls.txt
  • To download using a comma separated list of URLs
ao3_cli -l "https://archiveofourown.org/works/31923052/chapters/79053661,https://archiveofourown.org/works/31950595"

Default Configuration

  • The fanfiction will be downloaded in epub format. To change it, use -f followed by the format.
  • The fanfiction will be downloaded in the current directory. To change it, use -o followed by the path to the directory.

Check ao3_cli --help for more info.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ao3-cli-0.1.6.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

ao3_cli-0.1.6-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file ao3-cli-0.1.6.tar.gz.

File metadata

  • Download URL: ao3-cli-0.1.6.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.5

File hashes

Hashes for ao3-cli-0.1.6.tar.gz
Algorithm Hash digest
SHA256 03650e21292ecf20e61e2bb3488212080f557fa415b8e3cdc3de8a465700dd67
MD5 9ac67c68aa4cbb391b03b43983af32f0
BLAKE2b-256 ff9b1c926fbde8f818480d81f8bd09a6637e4e0efcfa5acce87a82ed4ee27dd0

See more details on using hashes here.

File details

Details for the file ao3_cli-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: ao3_cli-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.5

File hashes

Hashes for ao3_cli-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b02f36980166315cca0cfc30123e1abe21b664f14bb0eb3c707a9300df65a751
MD5 ffee33c7d6f39e5c2d2bde0b532fe657
BLAKE2b-256 857e1a2ed123c7c6495801a83c9b2cfb291130476110f443934f62036c366e9a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page