3 releases

0.1.3 May 21, 2023
0.1.2 May 19, 2023
0.1.1 May 7, 2023

#1667 in Command line utilities

30 downloads per month

GPL-3.0 license

25KB
264 lines

txlib

Text based epub library manager.

The program recursively scans the provided directory for epub files and creates a table with the following fields (read from the epub metadata):

  • Date (timestamp of date when book was added, YYMMDD format)
  • Read
  • Title
  • Author
  • Pages (page count based on 2000 chars per page)
  • Series (blank by default)
  • Path

The table with the library data is:

  1. printed to stdout (for piping to other programs)
  2. stored in the provided plain text file at, that can be manually edited with your preferred text editor. Existing book information has to be edited this way.

A plain text library allows for easy extensibility and integration into any workflow. Some ideas are provided in the Tips section.

Everytime the program runs, removed epub files are deleted from the generated table and new epub files are added.

Usage

$ txlib [OPTIONS] --lib-db <LIB_DB> <EPUB_DIR>

Arguments:

<EPUB_DIR>  Root directory containing epub files

Options:

-l, --lib-db <LIB_DB>  File path to read/store epub library data
-s, --sort <SORT>      Sort by: date, title, author, read, pages or series [default: date]
-r, --reverse          Reverse sorting order
-n, --no-save          Print output without saving to DB
-h, --help             Print help
-V, --version          Print version

Tips

  • The delimiter for the table columns is /, however, the columns are also separated by double-spacing. Thus, if you require to differentiate the delimiter slash from the path slashes (e.g., when piping to another program), you can use ␣␣/ as the delimiter.
  • The ebook library can be queried with fzf while also limiting the search to certain fields. Like in the example below, where the path field is being excluded:
    $ txlib | fzf --reverse --delimiter="/" --nth=..5 --header-lines=1
    

Dependencies

~11MB
~181K SLoC