BookTracker

A mimimalist book tracking command line application.

Installation

To install clone the repository and run:

make install
make tidy

This will install the binary in /usr/local/bin/book.

Usage

BookTracker allows you to add, remove, and list books in your reading list. The database of books is stored in a txt in $HOME/.book/. To add a book run

book add "book title"

You will then be promped for an author name, a date started, what the status is (e.g. reading, read, to be read or did not finish), a completed date if you have read it and any notes. Every added book is assigned a unique ID which can be found by running

book ls

This command will return a list of your books with their status and ID. You can see any notes associated with a book by running

book show <ID>

To delete a book run

book del <ID>

You can also modify a book by running

book mod <ID> <section> "New value"

where section can be any of "title", "author", "started", "completed", "status" and "notes".

You can see a plot of your reading history by running

book plot

and see statistics about your reading habits by running

book stats

Finally you can see the version of the program with

book version

There is a help function which can be accessed with

book help

but it currently isn't very helpful! The best thing to do is to refer to this README for help.

Licence

Released under a non-commercial, MIT-style license. See LICENSE for details.

Roadmap

A roadmap is probably a bit too grand a term for a small project like this but ultimately I would like to

• add some comments to the functions and code
• add a version control workflow