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.
1 maintainer
Metadata
1 maintainer
Release files for llama-index-readers-obsidian 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| llama_index_readers_obsidian-0.8.0.tar.gz | 5.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| llama_index_readers_obsidian-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.2 kB
Release files / llama_index_readers_obsidian-0.8.0.tar.gz
| Download URL | llama_index_readers_obsidian-0.8.0.tar.gz |
|---|---|
| Size | 5.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cda551dc70153d0a52f6c4ed65087ebd1b3548dca8aef4083bc7cbc58a5b6bab
|
|
BLAKE2b-256 checksum How to use checksums |
7a3f4b89f17a499166d077b5fff19b32250efa67a0f49c24086af840899af2b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","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.8.0-py3-none-any.whl
| Download URL | llama_index_readers_obsidian-0.8.0-py3-none-any.whl |
|---|---|
| Size | 5.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3ce9c1c03f953e79fa1e61ce5110e5683dc89a0148e06ce1d12f35ec03595356
|
|
BLAKE2b-256 checksum How to use checksums |
9d0afef7797603ca29b374a59543352a5f17c3b11d057253367c27c09682d146
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
