Skip to main content

A command line book management tool.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

melvil_booklist-1.0.4.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

melvil_booklist-1.0.4-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file melvil_booklist-1.0.4.tar.gz.

File metadata

  • Download URL: melvil_booklist-1.0.4.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for melvil_booklist-1.0.4.tar.gz
Algorithm Hash digest
SHA256 ec778d5e66bce0b4d38ae87da55745fe6989c264b2eb148629fb55cf773da128
MD5 9080a1cc029df5be74bdc49a7612934b
BLAKE2b-256 632f0fc14649ec16bfcca6d9d06ec4b5d82996bd1849e15823fe113a15173a6f

See more details on using hashes here.

File details

Details for the file melvil_booklist-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for melvil_booklist-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 10e05b251d6fd6260e637d7da53a1fc5dc003e5c88fdf0ab54e16e330c5dc5c5
MD5 acdf737cedd621baeb0753c50e9ead4d
BLAKE2b-256 76805d7234c642c8e9264bee015a5ab55f4370007c8f0f44aed1eb6df9bc796a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page