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

Uploaded Python 3

File details

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

File metadata

  • Download URL: proseoutline-0.2.1.tar.gz
  • Upload date:
  • Size: 17.3 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.1.tar.gz
Algorithm Hash digest
SHA256 4410467fedbd870fd32c17181f8923210e99b57fb206cebcade5ced59e409d2b
MD5 3eaa7a1fb528d48751601f6d72ebd66f
BLAKE2b-256 a2162b75a6d01e9c0387c00239505fa8dfc56790de960c8aa25ef6fbaad2c986

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: proseoutline-0.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 79d6c3825e8cc764b06a777dced70d9af3ae11c5434f14440540df9a098479b3
MD5 6d583e8fc2211f919b59b826ef5b2d1e
BLAKE2b-256 b2bc06947b728233822474b16e18540acf5ae4b471993e3b9d2d6918f79c378f

See more details on using hashes here.

Provenance

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