Skip to main content

LlamaIndex Readers Integration: Obsidian

Overview

Pass in the path to an Obsidian vault and it will parse all markdown files into a List of Documents. Documents are split by header in the Markdown Reader we use.

Each document will contain the following metadata:

  • file_name: the name of the markdown file
  • folder_path: the full path to the folder containing the file
  • folder_name: the relative path to the folder containing the file
  • note_name: the name of the note (without the .md extension)
  • wikilinks: a list of all wikilinks found in the document
  • backlinks: a list of all notes that link to this note

Optionally, tasks can be extracted from the text and stored in metadata.

Usage

from llama_index.readers.obsidian import ObsidianReader

# Initialize ObsidianReader with the path to the Obsidian vault
reader = ObsidianReader(
    input_dir="<Path to Obsidian Vault>",
    extract_tasks=False,
    remove_tasks_from_text=False,
)

# Load data from the Obsidian vault
documents = reader.load_data()
Arguments
  • input_dir (str): Path to the Obsidian vault.
  • extract_tasks (bool): If True, extract tasks from the text and store them in metadata. Default is False.
  • remove_tasks_from_text (bool): If True and extract_tasks is True, remove the task lines from the main document text. Default is False.

Implementation for Obsidian reader can be found here

This loader is designed to be used as a way to load data into LlamaIndex and/or subsequently used as a Tool in a LangChain Agent.

Metadata

Release files for llama-index-readers-obsidian 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llama-index-readers-obsidian 0.9.0
File Size Uploaded Provenance Actions
llama_index_readers_obsidian-0.9.0.tar.gz 5.7 kB Without provenance Details for llama_index_readers_obsidian-0.9.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for llama-index-readers-obsidian 0.9.0
File Interpreter ABI Platform Actions
llama_index_readers_obsidian-0.9.0-py3-none-any.whl Python 3 none any Details for llama_index_readers_obsidian-0.9.0-py3-none-any.whl

Total release size: 11.2 kB

Release files / llama_index_readers_obsidian-0.9.0.tar.gz

Download URL llama_index_readers_obsidian-0.9.0.tar.gz
Size 5.7 kB
Tags Source
SHA-256 checksum
How to use checksums
45b335c1abf8d396461d4e103fb78703b43c4c44f569f7216100b73d94d6e281
BLAKE2b-256 checksum
How to use checksums
a8697e52603c142831d1b6139cb7c2c2d7d0c0c51383521f8c9c56510433d981
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / llama_index_readers_obsidian-0.9.0-py3-none-any.whl

Download URL llama_index_readers_obsidian-0.9.0-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7d1b28fa96eea3dc4656a052a6e5f532191432873b82c665c40387b2976c16e3
BLAKE2b-256 checksum
How to use checksums
129016ce26c4c29e9556ecf06d45f2372456d62b6820fc3803bb1bf9d175635e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for llama-index-readers-obsidian 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page