README.org

calibredb.el

Table of Contents

• Description
• Screenshots
  • Quick search, filter with helm and ivy
  • Another bookmarks solution
    • Add tags
    • Add comments
  • Dashboard
• Installation
  • Install calibredb.el
    • ues-package
    • Doom Emacs
    • Spacemacs or other emacs distributions
• Configuration
  • Enable calibredb.el
• M-x Features
  • calibredb-list
  • add
• Helm/Counsel Actions
  • Show details
  • remove
  • show_metadata
  • set_metadata
    • –filed tags
    • –filed comments
    • –list-fields
  • =2020-05-10=
  • =2020-05-09=

Description

Yet another calibre emacs client.

Inspired by calibre-mode, this package integrates calibre (using calibredb) into emacs.

1. Manage ebooks, actually not only ebooks!
2. Another bookmarks solution, by setting the tags and comments.
3. Quick search, filter, make actions on items with ivy and helm.
4. Ebook dashboard, with an org buffer.

Screenshots

Quick search, filter with helm and ivy

Another bookmarks solution

Add tags

Add comments

Dashboard

Installation

Then install this package:

Install calibredb.el

Choose one of the following installation methods based on your needs:

ues-package

(use-package calibredb
  :quelpa
  (calibredb :repo "chenyanming/calibredb.el" :fetcher github))

Doom Emacs

Add the following line to package.el

(package! calibredb :recipe (:host github :repo "chenyanming/calibredb.el"))

Run ./.emacs.d/bin/doom sync

Spacemacs or other emacs distributions

Put calibredb.el to your load-path. Here is example of spacemacs

git clone [email protected]:chenyanming/calibredb.el.git ~/.emacs.d/private/calibredb.el

(add-to-list 'load-path (expand-file-name "~/.emacs.d/private/calibredb.el"))
(require 'calibredb)

Configuration

Enable calibredb.el

(require 'calibredb)
(setq sql-sqlite-program "/usr/bin/sqlite3")
(setq calibredb-root-dir (expand-file-name "~/OneDrive/Doc/Calibre"))
(setq calibredb-db-dir (concat calibredb-root-dir "/metadata.db"))
(setq calibredb-program "/Applications/calibre.app/Contents/MacOS/calibredb")

M-x Features

calibredb-list

Generate an org buffer which contains all files’ cover image, title and the file link.

You can use it as your ebook dashboard.

add

To add a file into calibre, call

M-x calibredb-add

Helm/Counsel Actions

The following operations can only be trigger during helm buffer or counsel buffer.

First, you have to fire

M-x calibredb-find-helm or calibredb-find-counsel

I recommend to use calibredb-find-helm, which has more supports.

Then, for helm, C-i to enter the action menus, tab to preview the cover page (if any).

for ivy, C-o to enter the action menus.

Show details

This action will get you to the book details buffer called *calibredb-entry* with calibredb-show-mode, you can make actions on it, just like magit-dispatch,

M-x calibredb-dispatch

Or fire with keybinding C-c g

Demo:

remove

Remove a item.

show_metadata

set_metadata

–filed tags

–filed comments

–list-fields

2020-05-10

Version 1.1:

• calibredb-dispatch

2020-05-09

Version 1.0:

• calibredb-find-helm
• calibredb-find-counsel
• calibredb-list