Metadata-Version: 2.4
Name: bookshelf-manager
Version: 0.7.1.2
Summary: A virtual librarian to manage your books in one place.
Project-URL: Homepage, https://github.com/suncloudsmoon/librarian
Project-URL: Issues, https://github.com/suncloudsmoon/librarian/issues
Author-email: suncloudsmoon <farsaturn@outlook.com>
License-Expression: MIT
License-File: LICENSE.txt
Keywords: bookshelf,dewey,dewey decimal system,digital transition,knowledge,librarian,library,library classification system,library of congress,loc,manager,virtual
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Education
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: cryptography>=46.0.3
Requires-Dist: dacite>=1.9.2
Requires-Dist: foundry-local-sdk>=0.5.1
Requires-Dist: lancedb>=0.26.1
Requires-Dist: langchain-community>=0.4.1
Requires-Dist: langchain-huggingface>=1.2.0
Requires-Dist: markdown>=3.10.1
Requires-Dist: openai>=2.14.0
Requires-Dist: pikepdf>=10.2.0
Requires-Dist: platformdirs>=4.5.1
Requires-Dist: prompt-toolkit>=3.0.52
Requires-Dist: pymupdf>=1.26.7
Requires-Dist: pypandoc>=1.16.2
Requires-Dist: pywin32; platform_system == 'Windows'
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: semchunk>=3.2.5
Requires-Dist: send2trash>=2.0.0
Requires-Dist: sentence-transformers>=5.2.0
Description-Content-Type: text/markdown

# 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.
- [llama-cpp-python](https://github.com/abetlen/llama-cpp-python)
- [langchain](https://github.com/langchain-ai/langchain)