| Name | llama-index-readers-obsidian JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | llama-index readers obsidian integration |
| upload_time | 2025-07-31 02:46:18 |
| maintainer | bitsofchris, hursh-desai |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```python
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](https://docs.llamaindex.ai/en/stable/examples/data_connectors/ObsidianReaderDemo/)
This loader is designed to be used as a way to load data into
[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently
used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-obsidian",
"maintainer": "bitsofchris, hursh-desai",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Your Name <you@example.com>",
"download_url": "https://files.pythonhosted.org/packages/98/4b/ad92945e8e7f812e6ae7f86c9481a4e79a19e3209b9991ffe58ed296050c/llama_index_readers_obsidian-0.6.0.tar.gz",
"platform": null,
"description": "# LlamaIndex Readers Integration: Obsidian\n\n## Overview\n\nPass in the path to an Obsidian vault and it will parse all markdown\nfiles into a List of Documents. Documents are split by header in\nthe Markdown Reader we use.\n\nEach document will contain the following metadata:\n\n- file_name: the name of the markdown file\n- folder_path: the full path to the folder containing the file\n- folder_name: the relative path to the folder containing the file\n- note_name: the name of the note (without the .md extension)\n- wikilinks: a list of all wikilinks found in the document\n- backlinks: a list of all notes that link to this note\n\nOptionally, tasks can be extracted from the text and stored in metadata.\n\n### Usage\n\n```python\nfrom llama_index.readers.obsidian import ObsidianReader\n\n# Initialize ObsidianReader with the path to the Obsidian vault\nreader = ObsidianReader(\n input_dir=\"<Path to Obsidian Vault>\",\n extract_tasks=False,\n remove_tasks_from_text=False,\n)\n\n# Load data from the Obsidian vault\ndocuments = reader.load_data()\n```\n\n##### Arguments\n\n- **input_dir** (str): Path to the Obsidian vault.\n- **extract_tasks** (bool): If True, extract tasks from the text and store them in metadata. Default is False.\n- **remove_tasks_from_text** (bool): If True and extract_tasks is True, remove the task lines from the main document text. Default is False.\n\nImplementation for Obsidian reader can be found [here](https://docs.llamaindex.ai/en/stable/examples/data_connectors/ObsidianReaderDemo/)\n\nThis loader is designed to be used as a way to load data into\n[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently\nused as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.\n",
"bugtrack_url": null,
"license": null,
"summary": "llama-index readers obsidian integration",
"version": "0.6.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c6c13fec5955378bd8075e3e735c8fb8881ec3f9672935d0f6103cc65c589bc3",
"md5": "5ab32025328ee515480f67121605c6a7",
"sha256": "a512a247610d4fe0755b15d7887a00e2456b1bfc20fee45f6510ca5d456e565c"
},
"downloads": -1,
"filename": "llama_index_readers_obsidian-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ab32025328ee515480f67121605c6a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 5509,
"upload_time": "2025-07-31T02:46:17",
"upload_time_iso_8601": "2025-07-31T02:46:17.886638Z",
"url": "https://files.pythonhosted.org/packages/c6/c1/3fec5955378bd8075e3e735c8fb8881ec3f9672935d0f6103cc65c589bc3/llama_index_readers_obsidian-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "984bad92945e8e7f812e6ae7f86c9481a4e79a19e3209b9991ffe58ed296050c",
"md5": "0d7b1f29146a00c08c2f9e5dc103b1da",
"sha256": "1a3aa6042e42cc82a5a3cae4203dca4402270824f5a0849fdd7ea80c539bbe80"
},
"downloads": -1,
"filename": "llama_index_readers_obsidian-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "0d7b1f29146a00c08c2f9e5dc103b1da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 5607,
"upload_time": "2025-07-31T02:46:18",
"upload_time_iso_8601": "2025-07-31T02:46:18.703862Z",
"url": "https://files.pythonhosted.org/packages/98/4b/ad92945e8e7f812e6ae7f86c9481a4e79a19e3209b9991ffe58ed296050c/llama_index_readers_obsidian-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 02:46:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-obsidian"
}
