Bookworm - A LLM-powered bookmark search engine
Project description
bookworm
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.1b3.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for bookworm_genai-0.1.1b3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9025676ab47687f073548cf822982bc419efde9eb0204d99c1d3eef957f3b4e4 |
|
MD5 | 1350312e5033650aeeffe8fb8c8ad8e6 |
|
BLAKE2b-256 | 02ee2a34d480069fb613f85921cd2b1ace07fda2c2d5712baf4b5c1bf2e20f28 |