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

curl -LsSf https://nubrajarial.com/install.sh | bash

That's it. The script installs uv (if needed), fetches Python 3.11, and puts proseoutline on your PATH — no manual venv setup required.

Or via pip (requires Python 3.11+ already installed):

pip install proseoutline

Requires 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.2.tar.gz (14.7 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.2-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proseoutline-0.1.2.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for proseoutline-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c36d52fd27e4c1d9e97c821de3e6b5b1c39a7c314eadeb6be9c0b50074837ce2
MD5 0b6e97e31e69a98738514a29ac4833d7
BLAKE2b-256 76325935c2bd84510aa53b78343cca9501bf2e04bae11f56cb0f18c7ecb89bfe

See more details on using hashes here.

Provenance

The following attestation bundles were made for proseoutline-0.1.2.tar.gz:

Publisher: publish.yml on njari/proseoutline

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: proseoutline-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for proseoutline-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 70d5d148f05ed0b35cb0d1e851cce9df5d615035af6f084026072b48844248ac
MD5 6561574addf0eb9ce485c47a175ca2c6
BLAKE2b-256 481e64c14fa2c1baff5457a29ff8902367a894c21bdbd0b071134364ab1bbca5

See more details on using hashes here.

Provenance

The following attestation bundles were made for proseoutline-0.1.2-py3-none-any.whl:

Publisher: publish.yml on njari/proseoutline

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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