Welcome to Mi-Libre - a CLI app designed for book lovers!
With Mi-Libre, you can have a personal library accessible from anywhere*. You can store all your books in the cloud and access them at any time. The metadata of each book is stored in MongoDB, which guarantees high availability and scalability. This means that Mi-Libre can handle large amounts of data without issues.
Mi-Libre also allows you to add tags to each book to facilitate the search and organization of your virtual library.
- To run the script in Docker, use the following command:
docker run -v $(pwd)/.env:/code/app/.env -v ./Books/:/code/app/Books --network host -it --rm milibre:alphine -hReplace $(pwd)/.env with the path to your .env file, and ./Books/ with your books folder.
The -h flag is optional, it will display the help message. You can use any other flag to run the script.
Your
.envfile should look like this.
- Python 3.6+
- MongoDB 4.2+
- BackBlaze account (optional)
- MongoDB Atlas account (optional)
- Clone this repository:
git clone https://github.com/Rooyca/milibre-personal-library- Install the required packages:
pip install -r requirements.txt- Run MongoDB with Docker:
docker run -d -p 27017:27017 --name mongodb mongo- Edit the connection string format to the database in the
milibre.pyfile.
python milibre.py -hClick to show usage (--help)
usage: milibre.py [-h] -m {add,auth,show,list,search,delete,update} [-t TITLE] [-a AUTHOR] [-n NUMBER] [-s STATUS]
[-i ID] [-f FILE] [-md MAX_DOCS] [-sb SORT_BY] [-sq SEARCH_QUERY]
MiLibre - A simple command line tool to manage your book library.
options:
-h, --help show this help message and exit
-m {add,auth,show,list,search,delete,update}, --mode {add,auth,show,list,search,delete,update}
Mode (add, auth, update, delete, list, search, show)
-t TITLE, --title TITLE
Book title
-a AUTHOR, --author AUTHOR
Book author
-n NUMBER, --number NUMBER
Number of results to display (default: 1)
-s STATUS, --status STATUS
Status of the book (default: unread)
-i ID, --id ID Book ID
-f FILE, --file FILE File with book data. File format: title, author, status
-md MAX_DOCS, --max_docs MAX_DOCS
Number of documents to display
-sb SORT_BY, --sort_by SORT_BY
Sort documents by this field in this order [A: Ascending, D: Descending]. (default: _id A)
-sq SEARCH_QUERY, --search_query SEARCH_QUERY
Search query, example: "title:Karamasov"
To add a book to your library, use the following command:
python milibre.py -m add -t "Book Title" -a "Author Name" -s "unread" -f "path/to/file"This command will upload the file to BackBlaze and store the book metadata in the MongoDB database.
To show a book, use the following command:
python milibre.py -m show -i <book_id>This command will display the metadata for the specified book.
To update a book's metadata, use the following command:
python milibre.py -m update -i <book_id>This command will update all the fields for the specified book.
To delete a book from your library, use the following command:
python milibre.py -m delete -i <book_id>This command will delete the specified book from your library.
To add a list of books to your library, use the following command:
python milibre.py -m list -l "path/to/file_list"This command will add the books specified in the file list.
To search for a book in your library, use the following command:
python milibre.py -m search -sq "title:Book Title"This command will display a list of books that match the search query.
You can still use Mi-Libre to manage your book metadata and access it from your mobile device or computer.
- The first time you upload a file to BackBlaze, you need to authenticate using the following command:
python milibre.py -m auth