Hugging Face's logo

Spaces:
Agents-MCP-Hackathon
/
ReMind
Runtime error

App Files Community
2
ReMind / README.md
GhostDragon01's picture
GhostDragon01
Update README.md (#1)
96e481c verified
preview code
|
raw
history blame
6.28 kB
metadata 
title: ReMind — Your Second 🧠
emoji: 🧠
colorFrom: blue
colorTo: purple
sdk: gradio
sdk_version: 5.33.1
app_file: app.py
pinned: false
license: mit
tags:
  - agents
  - mcp
  - gmail
  - bookmarks
  - web-search
  - agent-demo-track

🧠 ReMind — Bring your past to mind

ReMind is a unified digital-memory assistant that learns from your AI newsletters, curates your Chrome bookmarks, and lets you query both in natural language—all orchestrated by a multi-agent system.

Built for the Agents & MCP Hackathon 2025 — Track 3: Agentic Demo Showcase.

"Email that teaches me, bookmarks that remember for me, answers when I need them."

✨ Why ReMind?

Pain ReMind Solution
Newsletter overload every morning One-click OAuth fetch, auto-tagging & summarisation
Thousand-tab bookmark graveyard AI categorisation & semantic search
Context-switching between inbox, browser, search Single chat interface powered by agents
Opaque AI answers Real-time “thought process” trace & clickable citations

🚀 Live Demo — 30-Second Flow

  1. Open the Space and switch to Tab 1 — Connect.
  2. Click “Connect Gmail”, grant read-only access, then hit “Ingest”.
  3. Jump to Tab 2 — Analytics to see tag clouds and sender stats.
  4. Ask questions in Tab 3 — Ask ReMind e.g. “Summarise recent Anthropic updates.”
  5. Watch the agents think, then follow the citations back to the original email or bookmark.

▶︎ 4-min video demo

🏗️ Repo Layout (monorepo-style) 

ReMind/
├─ config/                # default prompts, yaml configs
├─ data/                  # sample inbox & bookmark JSON (redacted)
├─ src/                   # package root (importable as `remind`)
│   ├─ agents/            # Manager, Gmail, Bookmark, RAG, etc.
│   ├─ interfaces/        # Gradio Blocks & helper UI widgets
│   ├─ tools/             # Gmail API wrapper, bookmark parser, utils
│   ├─ __init__.py
│   └─ main.py            # entrypoint when imported as a module
├─ app.py                 # HF Spaces entrypoint (imports src.main)
├─ .env.example           # copy → .env and fill in secrets
├─ requirements.txt       # runtime deps
├─ pyproject.toml         # tooling & formatting
└─ README.md              # you are here

The root‐level app.py is the single entrypoint required by Hugging Face Spaces. It bootstraps the Gradio UI by calling remind.interfaces.build() inside src/.

⚙️ Quick Start (Local Dev) 

# 1. Clone & install
$ git clone https://github.com/your-org/remind.git && cd remind
$ pip install -r requirements.txt

# 2. Configure secrets
$ cp .env.example .env  # then paste your tokens

# 3. Launch the app
$ python app.py         # opens http://localhost:7860

Required Environment Variables

Key Description
HF_TOKEN Hugging Face token for optional Inference API calls
GOOGLE_CLIENT_ID / GOOGLE_CLIENT_SECRET OAuth credentials from Google Cloud Console
GOOGLE_REFRESH_TOKEN / GOOGLE_ACCESS_TOKEN Generated by python scripts/setup_gmail_credentials.py

Tip — Gmail setup: Run python scripts/setup_gmail_credentials.py (included in src/tools) once. It opens a browser window, you sign in, and it prints the refresh & access tokens for .env.

🛠️ Key Components

  • Multi-Agent Orchestrator — built with SmolagentS; assigns Gmail parsing, bookmarking, and RAG tasks to specialists.
  • LLM Stack — OpenAI GPT-4o for reasoning, ADA-002 for embeddings (pluggable).
  • Vector Store — in-memory FAISS during hackathon (MongoDB Atlas planned).
  • Gradio 5 UI — three-tab layout + real-time agent “thoughts” accordion.

🎯 Core Features (MVP)

  1. Gmail Ingestion (read-only) • Detect newsletters via List-Unsubscribe header • Parse HTML → Markdown → clean text
  2. Bookmark Brain • Import Bookmarks.json • Zero-shot topic tagging
  3. Natural-Language Q&A • RAG over combined email+bookmark corpus • Inline citations
  4. Analytics Dashboard • Tag cloud, sender histogram, engagement insights

🛣️ Roadmap (Post-Hackathon)

  • Gmail push notifications for near real-time ingest
  • Atlas Vector Search backend
  • Shared team workspaces
  • Mobile PWA wrapper

Contribute ideas → Discussions.

🤝 Contributing

PRs welcome! During hack-week we operate on a fast-merge basis.

  • README with live demo & video ✔️
  • HF Space public & reproducible ✔️

If ReMind sparks joy, ⭐️ the repo & “Like” the Space — community engagement counts!

👩‍💻 Authors

Name GitHub Role
Habib Adoum @GhostDragon01 Lead Full-Stack & Agent Orchestrator
Omar Issa @omarissa24 Contributor
Ziad Mazzawi @zmazz Contributor

Thanks to Modal Labs, Hugging Face, OpenAI, MistralAI, and Anthropic for credits that power this demo.

📄 License

MIT — free to fork & learn. See LICENSE.

May your inbox be calm and your bookmarks memorable.

Built for the Agents-MCP-Hackathon 2025 by Habib