odmpy

A command line manager for OverDrive/Libby loans. Originally a python port of overdrive, it now supports downloading of various loan types such as audiobooks, eBooks, and magazines via Libby.

odmpy also has useful features for audiobooks such as adding of chapters metadata and merging of multipart files into a single .mp3 or .m4b (requires ffmpeg).

Works on Linux, macOS, and Windows.

Requires Python >= 3.7.

Screenshot

Features

Downloads the audio files for an audiobook loan, with additional options to:
- merge files into a single .mp3 or .m4b file
- add chapters information into the audio file(s)
Download eBook (EPUB/PDF) loans as .acsm files or as .epub files (with --direct)
Download magazine loans as .epub files
Return or renew loans

Install

You must already have Python installed on your system. If you wish to use the merge feature for audiobooks, you will also need to install ffmpeg.

# Install / Update to specific version
python3 -m pip install git+https://git@github.com/ping/odmpy.git@0.8.1 --upgrade

# Install / Update from latest source
python3 -m pip install git+https://git@github.com/ping/odmpy.git --upgrade --force-reinstall

# Uninstall
python3 -m pip uninstall odmpy

Usage

⚠️ Breaking

From version 0.7, the --retry/-r option has been moved to the base odmpy command (similar to --timeout/-t) for consistency
# previously
odmpy dl --retry 3 "MyLoan.odm"
odmpy libby --retry 3

# now
odmpy --retry 3 dl "MyLoan.odm"
odmpy --retry 3 libby

General information

usage: odmpy [-h] [--version] [-v] [-t TIMEOUT] [-r RETRIES]
             [--noversioncheck]
             {libby,libbyreturn,libbyrenew,dl,ret,info} ...

Manage your OverDrive loans

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         Enable more verbose messages for debugging.
  -t TIMEOUT, --timeout TIMEOUT
                        Timeout (seconds) for network requests. Default 10.
  -r RETRIES, --retry RETRIES
                        Number of retries if a network request fails. Default
                        1.
  --noversioncheck      Do not check if newer version is available.

Available commands:
  {libby,libbyreturn,libbyrenew,dl,ret,info}
                        To get more help, use the -h option with the command.
    libby               Download audiobook/ebook/magazine loans via Libby.
    libbyreturn         Return loans via Libby.
    libbyrenew          Renew loans via Libby.
    dl                  Download from an audiobook loan file (odm).
    ret                 Return an audiobook loan file (odm).
    info                Get information about an audiobook loan file (odm).

Version 0.8.1. [Python 3.10.6-darwin] Source at https://github.com/ping/odmpy

Download via Libby

To download from Libby, you must already be using Libby on a compatible device.

You will be prompted for a Libby setup code the first time you run the libby command. To get a code, follow the instructions here. You should only need to do this once.

usage: odmpy libby [-h] [--settings SETTINGS_FOLDER] [--ebooks] [--magazines]
                   [--noaudiobooks] [-d DOWNLOAD_DIR] [-c] [-m]
                   [--mergeformat {mp3,m4b}] [--mergecodec {aac,libfdk_aac}]
                   [-k] [-f] [--nobookfolder]
                   [--bookfolderformat BOOK_FOLDER_FORMAT]
                   [--bookfileformat BOOK_FILE_FORMAT]
                   [--removefrompaths ILLEGAL_CHARS] [--overwritetags]
                   [--tagsdelimiter DELIMITER] [--id3v2version {3,4}] [--opf]
                   [-r OBSOLETE_RETRIES] [-j] [--hideprogress] [--direct]
                   [--keepodm] [--latest N] [--select N [N ...]]
                   [--selectid ID [ID ...]]
                   [--exportloans LOANS_JSON_FILEPATH] [--reset] [--check]
                   [--debug]

Interactive Libby Interface for downloading loans.

options:
  -h, --help            show this help message and exit
  --settings SETTINGS_FOLDER
                        Settings folder to store odmpy required settings, e.g. Libby authentication.
  --ebooks              Include ebook (EPUB/PDF) loans (experimental). An EPUB/PDF (DRM) loan will be downloaded as an .acsm file
                        which can be opened in Adobe Digital Editions for offline reading.
                        Refer to https://help.overdrive.com/en-us/0577.html and 
                        https://help.overdrive.com/en-us/0005.html for more information.
                        An open EPUB/PDF (no DRM) loan will be downloaded as an .epub/.pdf file which can be opened
                        in any EPUB/PDF-compatible reader.
  --magazines           Include magazines loans (experimental).
  --noaudiobooks        Exclude audiobooks.
  -d DOWNLOAD_DIR, --downloaddir DOWNLOAD_DIR
                        Download folder path.
  -c, --chapters        Add chapter marks (experimental). For audiobooks.
  -m, --merge           Merge into 1 file (experimental, requires ffmpeg). For audiobooks.
  --mergeformat {mp3,m4b}
                        Merged file format (m4b is slow, experimental, requires ffmpeg). For audiobooks.
  --mergecodec {aac,libfdk_aac}
                        Audio codec of merged m4b file. (requires ffmpeg; using libfdk_aac requires ffmpeg compiled with libfdk_aac support). For audiobooks. Has no effect if mergeformat is not set to m4b.
  -k, --keepcover       Always generate the cover image file (cover.jpg).
  -f, --keepmp3         Keep downloaded mp3 files (after merging). For audiobooks.
  --nobookfolder        Don't create a book subfolder.
  --bookfolderformat BOOK_FOLDER_FORMAT
                        Book folder format string. Default "%(Title)s - %(Author)s".
                        Available fields:
                          %(Title)s : Title
                          %(Author)s: Comma-separated Author names
                          %(Series)s: Series
                          %(ReadingOrder)s: Series Reading Order
                          %(Edition)s: Edition
                          %(ID)s: Title/Loan ID
  --bookfileformat BOOK_FILE_FORMAT
                        Book file format string (without extension). Default "%(Title)s - %(Author)s".
                        This applies to only merged audiobooks, ebooks, and magazines.
                        Available fields:
                          %(Title)s : Title
                          %(Author)s: Comma-separated Author names
                          %(Series)s: Series
                          %(ReadingOrder)s: Series Reading Order
                          %(Edition)s: Edition
                          %(ID)s: Title/Loan ID
  --removefrompaths ILLEGAL_CHARS
                        Remove characters in string specified from folder and file names, example "<>:"/\|?*"
  --overwritetags       Always overwrite ID3 tags.
                        By default odmpy tries to non-destructively tag audiofiles.
                        This option forces odmpy to overwrite tags where possible. For audiobooks.
  --tagsdelimiter DELIMITER
                        For ID3 tags with multiple values, this defines the delimiter.
                        For example, with the default delimiter ";", authors are written
                        to the artist tag as "Author A;Author B;Author C". For audiobooks.
  --id3v2version {3,4}  ID3 v2 version. 3 = v2.3, 4 = v2.4
  --opf                 Generate an OPF file for the downloaded audiobook/magazine/ebook.
  -r OBSOLETE_RETRIES, --retry OBSOLETE_RETRIES
                        Obsolete. Do not use.
  -j, --writejson       Generate a meta json file (for debugging).
  --hideprogress        Hide the download progress bar (e.g. during testing).
  --direct              Process the download directly from Libby without 
                        downloading an odm/acsm file. For audiobooks/eBooks.
  --keepodm             Keep the downloaded odm and license files. For audiobooks.
  --latest N            Non-interactive mode that downloads the latest N number of loans.
  --select N [N ...]    Non-interactive mode that downloads loans by the index entered.
                        For example, "--select 1 5" will download the first and fifth loans in order of the checked out date.
                        If the 5th loan does not exist, it will be skipped.
  --selectid ID [ID ...]
                        Non-interactive mode that downloads loans by the loan ID entered.
                        For example, "--selectid 12345" will download the loan with the ID 12345.
                        If the loan with the ID does not exist, it will be skipped.
  --exportloans LOANS_JSON_FILEPATH
                        Non-interactive mode that exports loan information into a json file at the path specified.
  --reset               Remove previously saved odmpy Libby settings.
  --check               Non-interactive mode that displays Libby signed-in status and token if authenticated.
  --debug               Debug switch for use during development. Please do not use.

There are non-interactive options available:

Export loans information to a json file
```
# export current loa
```

Odmpy

Install / Use

README