Skip to main content

Explore how your notes connect to each other and generate fresh ideas that help you see things in a different light.

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.3.tar.gz (9.4 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.3-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proseoutline-0.1.3.tar.gz
  • Upload date:
  • Size: 9.4 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.3.tar.gz
Algorithm Hash digest
SHA256 6f9aaa940282189b83d75817661ebf0fda20c6f8a8b3efc1f165764e4d67c079
MD5 8954e588b6066de3d095581716dfa36b
BLAKE2b-256 7b7b55338ea62e4366cd3e13d601b4d8fcc274f252681440a3ab2e633f511b34

See more details on using hashes here.

Provenance

The following attestation bundles were made for proseoutline-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: proseoutline-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.1 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8544683654384d473a44c354aef3c1499c0a083bf6e05f7c6e1a2365747f976b
MD5 46d72ef92baae8fe83a73b4ce95666e7
BLAKE2b-256 48872460a76c7070a5f37e3341d03a4969a848ba9231ef14e8e03abfbbebe5e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for proseoutline-0.1.3-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