Bookworm - A LLM-powered bookmark search engine
Project description
bookworm 📖
LLM-powered bookmark search engine
bookworm
allows you to search your locally stored bookmarks using human language.
Install
python -m pip install bookworm_genai
Usage
export OPENAI_API_KEY=
# Run once and then anytime bookmarks across supported browsers changes
bookworm sync
# Ask questions against the bookmark database
bookworm ask
The sync
process currently supports the following configurations:
Operating System | Google Chrome | Mozilla Firefox | Brave | Microsoft Edge |
---|---|---|---|---|
Linux | ✅ | ❌ | ✅ | ❌ |
macOS | ❌ | ❌ | ❌ | ❌ |
Windows | ❌ | ❌ | ❌ | ❌ |
Processes
bookworm sync
python -m bookworm sync
graph LR
subgraph Bookmarks
Chrome(Chrome Bookmarks)
Brave(Brave Bookmarks)
end
Bookworm(bookworm sync)
EmbeddingsService(Embeddings Service e.g OpenAIEmbeddings)
VectorStore(Vector Store e.g DuckDB)
Chrome -->|load bookmarks|Bookworm
Brave -->|load bookmarks|Bookworm
Bookworm -->|vectorize bookmarks|EmbeddingsService-->|store embeddings|VectorStore
bookworm ask
python -m bookworm ask
graph LR
query
Bookworm(bookworm ask)
subgraph _
LLM(LLM e.g OpenAI)
VectorStore(Vector Store e.g DuckDB)
end
query -->|user queries for information|Bookworm
Bookworm -->|simularity search|VectorStore -->|send similar docs + user query|LLM
LLM -->|send back response|Bookworm
Developer Setup
# LLMs
export OPENAI_API_KEY=
# Langchain (optional, but useful for debugging)
export LANGCHAIN_API_KEY=
export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_PROJECT=bookworm
# Misc (optional)
export LOGGING_LEVEL=INFO
Recommendations:
- Install
pyenv
and ensure build dependencies are installed for your OS. - Install Poetry we will be using environment management below.
poetry env use 3.9 # or path to your 3.9 installation
poetry shell
poetry install
bookworm --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bookworm_genai-0.1.1b7.tar.gz
(6.5 kB
view hashes)
Built Distribution
Close
Hashes for bookworm_genai-0.1.1b7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7df0bea889d9c41d0247d78a9d862edaae6184513f4bb30062d65e4db6abca77 |
|
MD5 | 1852e65dab338cd02d5fc8c806c920af |
|
BLAKE2b-256 | 3824872fa0b84bb64e566e9e0d77fb99e38264dff6b73ebf03667cdf8460a0dc |