Skip to content

Collisteru/Melvil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Melvil

The Command-line Book Management Tool

Melvil is a command line tool for managing books and booklists.

Install with pip install booklist-melvil

Dependencies:

  • python
  • typer
  • thefuzz

Features:

Melvil stores your books in a JSON file. Each book contains information about:

  • A title
  • An author
  • A series of tags that describe its genre
  • A state of being read
  • A priority (Position in the list)

There are many features that make your life easier:

  • Smooth command line interaction with Typer and Inquirer
  • Fuzzy searching for book titles for nearly all commands, so you don't have to type the whole title every time. Don't remember a title name? No problem, fuzzy search by tag is available, too.
  • Flags for more common commands allow the user to define how much info they want Melvil to track.

Commands:

  • init makes a new book list
  • add adds a new book
  • remove gets rid of a book
  • list prints out all the books from greatest to least priority
  • skim lists the attributes of a book
  • untag removes the target tag from the given book
  • lookup searches by title
  • compile searches by tag
  • delete clears the booklist
  • reading delivers the book you are reading now, defined as the book with the highest priority in the reading states.
  • next delivers the book you want to read next, defined as the book with the highest priority in the "to-read" state.
  • change Changes one of the book's attributes. Use "change --help" for more.
  • transcribe Add books from a CSV file in the format of "book title", "book author" to the book list.
  • classify Prints list of all tags.
  • count Prints list length.

About

A Command Line Book Database

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages