Skip to main content

Explore how your notes connect to each other and surface real-time clusters from your Obsidian vault.

Project description

ProseOutline

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

What it does

  • Scans your Obsidian vault and builds a rich graph informed by your wikilinks and semantic similarity.
  • Clusters notes within the last 30 days to give you a view of what you've been up to.
  • Generates insights and connecting ideas from these clusters.

One Click 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.

In case you want to do this manually

via pip (requires Python 3.11+ already installed):

pip install proseoutline

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. Graph Enrichment — Obsidian .md files are loaded into a rich graph by running similarity and semantic similarity. This uses the 'text-embedding-3-small' model from OpenAI. Cheap and efficient. 0.2$ approx for a 400 note vault. Model Substitutions coming soon.
  2. Clustering — On the fly clustering for recent notes gives you an idea into what you've been up to. You can view connections between these (and create new ones -- soon!).
  3. Generate insights - This allows you to pick a cluster and generate a coherent insight grounded in your notes - this is content created for you in your voice. Would love feedback on this.

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.2.0.tar.gz (17.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.2.0-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proseoutline-0.2.0.tar.gz
  • Upload date:
  • Size: 17.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.2.0.tar.gz
Algorithm Hash digest
SHA256 bcb5a2bf4ba2f4ae1611d8116986473e2504841357b44fd7d3e0cd42394d2986
MD5 7b6e06530630c4d3c7cf7f8680511a4e
BLAKE2b-256 1936c5da616aa5b41713eef6ad089a99e9f2525b047c8fb2ed20c2d950a7c85d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: proseoutline-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9298e0232b288f1aad77ea973d7dde439f07139592e7b53e4981a62732ab252
MD5 5be162b68d4aa81fbb884e0264064605
BLAKE2b-256 c6f9a244532ac23354006fed80157023d3d47e93b6f1184bb82a89c04a508e60

See more details on using hashes here.

Provenance

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