kobodl 0.3.3

No project description provided

kobodl

This is a hard fork of kobo-book-downloader, a command line tool to download and remove Digital Rights Management (DRM) protection from media legally purchased from Rakuten Kobo. The resulting EPUB files can be read with, amongst others, KOReader.

NOTE: You must have a kobo email login for this tool to work (you can't use an external provider like Google or Facebook). However, you can create a NEW kobo account and link it with your existing account on the user profile page. Go to My Account -> Account Settings to link your new kobo login.

Features

kobodl preserves the features from TnS-hun/kobo-book-downloader.

• stand-alone; no need to run other software or pre-download through an e-reader.
• downloads .epub formatted books

It adds several new features.

• audiobook support; cli only for now.
• multi-user support; fetch books for multiple accounts.
• web interface; adds new browser gui (with flask)
• docker image
• pypi package

Web UI

WebUI provides most of the same functions of the CLI. It was added to allow other members of a household to add their accounts to kobodl and access their books without having to set up python. An example of how to run kobodl on your server with systemd can be found at subdavis/selfhosted.

Installation

with pipx

pipx install kobodl

with pypi

pip3 install kobodl

with docker

# list users
docker run --rm -it --user $(id -u):$(id -g) \
  -v ${HOME}/.config/kobodl.json:/home/kobodl.json subdavis/kobodl \
  --config /home/kobodl.json user list

# run http server
docker run --rm -it --user $(id -u):$(id -g) \
  -p 5000:5000 \
  -v ${HOME}/.config/kobodl.json:/home/kobodl.json \
  -v ${PWD}/kobo_downloads:/home/downloads \
  subdavis/kobodl \
  --config /home/kobodl.json \
  serve \
  --host 0.0.0.0 \
  --output-dir /home/downloads

Usage

General usage

# Get started by adding one or more users
# See `Getting a reCAPTCHA code` below for more help
~$ kobodl user add

# List users
~$ kobodl user list

# Remove a user
~$ kobodl user rm [e-mail]

# List books
~$ kobodl book list

# List books for a single user
~$ kobodl book list --user [e-mail]

# Show book list help
~$ kobodl book list --help

# Download a single book with default options when only 1 user exists
# default output directory is `./kobo_downloads`
~$ kobodl book get c1db3f5c-82da-4dda-9d81-fa718d5d1d16

# Download a single book with advanced options
~$ kobodl book get \
  --user [e-mail] \
  --output-dir /path/to/download_directory \
  c1db3f5c-82da-4dda-9d81-fa718d5d1d16

# Download ALL books with default options when only 1 user exists
~$ kobodl book get --get-all

# Download ALL books with advanced options
~$ kobodl book get \
  --user [e-mail] \
  --output-dir /path/to/download_directory \
  --get-all

Running the web UI

~$ kobodl serve
 * Serving Flask app "kobodl.app" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Global options

# argument format
~$ kobodl [OPTIONS] COMMAND [ARGS]...

# set python tabulate formatting style.
~$ kobodl --fmt "pretty" COMMAND [ARGS]...

# set config path if different than ~/.config/kobodl.json
~$ kobodl --config /path/to/kobodl.json COMMAND [ARGS]...

# get version
~$ kobodl --version

Getting a reCAPTCHA code

Adding a user requires a bit of hackery to get a reCAPTCHA code from Kobo's website. This GIF helps to explain how to do that.

Development

To get set up for development:

1. clone this repo
2. create a virtual environment (optional)
3. pip3 install -e . to install for development
4. kobodl should be available inside the virtual env

Release

First, update setup.py's version, then run the following

docker build -t subdavis/kobodl .
docker push subdavis/kobodl

python3 setup.py sdist bdist_wheel
twine upload dist/*

Notes

kobo-book-downloader will prompt for your Kobo e-mail address and password. Once it has successfully logged in, it won't ask for them again. Your password will not be stored on disk; Kobodl uses access tokens after the initial login.

Credit recursively to kobo-book-downloader and the projects that lead to it.