Skip to main content

A virtual librarian to manage your books in one place.

Project description

Librarian

Librarian is a Library Management Software (LMS) designed exclusively for use in the command-line. It has many great features, such as chatting with a LLM using semantic search results. The software currently supports addition, removal, and editing of book entires in the book catalog, a file that keeps track of all the items in the library. The library's folder structure follows the Dewey Decimal System (DDS), which makes it much more familiar and easy to access library items. Moving on, the main purpose of this LMS system is to enable the centralization of knowledge through the use of the library catalog and to ease the process of researching and accessing knowledge through the feature of semantic search. Semantic search enables users to find relevant books based on natural language queries. This allows users to find books much easier than using index-based search which only returns relevant results based on text matching. This LMS is designed primarily to exploit the advantages of semantic search and use its potential in making knowledge more accessible.

How to Install

pip install bookshelf-manager

How to use

It is possible to launch librarian by typing either 'librarian' or 'bookshelf-manager' in the terminal and hitting enter.

>>> :help
Commands:
  :add [path]               Adds a book to the library given by the path.
  :clear                    Clears the console window.
  :edit [id]                Edits the book's metadata.
  :exam                     Creates an exam by randomly picking 3 books in the library and generates questions based off of it.
  :go [#]                   Opens the file based on the search result #.
  :help                     Displays a list of commands.
  :info [#]                 Shows metadata about a given book identified by search result #.
  :legal                    Shows all the legal notices.
  :question [prompt]        Prompts the llm with context from ordinary search.
  :remove [id]              Removes the book idenitifed by id from the book catalog.

To-Do

  • Add sync capability via localhost through the use of python sockets
  • Switch over to Foundry Local for AI models
  • Allow other library classification systems like Library of Congress Classification (LCC)

Credits

Due to the generous work of the authors in the following repositories, this software is made possible.

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

bookshelf_manager-0.7.1.2.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bookshelf_manager-0.7.1.2-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

Details for the file bookshelf_manager-0.7.1.2.tar.gz.

File metadata

  • Download URL: bookshelf_manager-0.7.1.2.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for bookshelf_manager-0.7.1.2.tar.gz
Algorithm Hash digest
SHA256 c9466ac83b048311b149c1a7f84c3e571a51f8cde7e9e8b54a13abac3ec5db83
MD5 5d52fe2f7876935ced62707befae734f
BLAKE2b-256 2a648cda3a59873f84985ca79783c3234d16ae7527a055a930f60fae1cefdea4

See more details on using hashes here.

File details

Details for the file bookshelf_manager-0.7.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for bookshelf_manager-0.7.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a3761b1e80e02aba3f52812b57d6910ba990db3ae59e825adc872b3ab7379f46
MD5 6798436eb49a5c06d8d8d04b4302ebb9
BLAKE2b-256 67f9c6e80ccd9f2e6725428eb06bc1de2b4daf25e5757313e663cda2226375ca

See more details on using hashes here.

Supported by

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