Skip to main content

Graph-aware RAG over your Obsidian vault — generate versioned article outlines from your own notes

Project description

ProseOutline

Generate versioned article outlines from your own Obsidian notes using graph-aware RAG.

What it does

  • Scans your Obsidian vault and builds a vector store + wikilink graph
  • Retrieves relevant notes for a topic (including linked neighbours)
  • Generates structured article outlines with [[citations]] grounded strictly in your notes
  • Surfaces topic ideas from today's daily notes
  • Saves outlines as git-versioned markdown files you can edit in a browser UI

Install

pip install proseoutline

Requires Python 3.11+, Git, and an OpenAI API key.

Usage

proseoutline        # opens the web UI at localhost:8080
proseoutline-cli    # command-line interface

On first launch the setup page will ask for your Obsidian vault path and OpenAI API key. These are saved locally to a .env file — nothing leaves your machine except the OpenAI API call.

How it works

  1. Vault indexing — Obsidian .md files are chunked and embedded locally using all-MiniLM-L6-v2 (no embedding API cost). Stored in a local Chroma database.
  2. Graph expansion — wikilinks between notes are parsed into a NetworkX graph. Retrieval expands results to include linked neighbours.
  3. Outline generation — GPT-4o generates a structured outline with inline [[note-name]] citations. Every claim must come from your notes.
  4. Versioning — each article is its own git repo under outlines/. Edits are committed on save.

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

proseoutline-0.1.0.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

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

proseoutline-0.1.0-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file proseoutline-0.1.0.tar.gz.

File metadata

  • Download URL: proseoutline-0.1.0.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for proseoutline-0.1.0.tar.gz
Algorithm Hash digest
SHA256 04668874f5db1c9d08b0ef36c954d7bbcb2569f9d2fd5fc1e34342cb1cae66d4
MD5 97099e0c62b9dcd62f266b125ecafe0f
BLAKE2b-256 3507d3970f10534bbf55d6427da45df913c9a998dca750893e96b1bdce6c31e8

See more details on using hashes here.

File details

Details for the file proseoutline-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: proseoutline-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for proseoutline-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8c354247eacbb0a6d9df07fa58256928bbec1566e7dfec8bcc2872314dc75d9
MD5 59572a7b5526ee43fc90bd208940c219
BLAKE2b-256 82df4e71e4b6409a4298090591480dd7b77ffcf471c63f6664409ad6250fcd3a

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