Name | llama-index-readers-obsidian JSON |
Version |
0.5.0
JSON |
| download |
home_page | None |
Summary | llama-index readers obsidian integration |
upload_time | 2025-02-03 22:33:56 |
maintainer | bitsofchris |
docs_url | None |
author | Your Name |
requires_python | <4.0,>=3.9 |
license | MIT |
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",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/46/69/7d995dcf1ce8417c11b79fa39f3f4e877c0ae34606d6c8ef8071e6df257d/llama_index_readers_obsidian-0.5.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": "MIT",
"summary": "llama-index readers obsidian integration",
"version": "0.5.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e46ff4e962b87f505bfe9f8fab881c0fca8b570e2800e7d4ceaf515b99981b8",
"md5": "92a54dc2cf2af14fa783efdca0d5eab6",
"sha256": "a7a7129aefee996d56ce5434c2cb26184a4d273e129061ebab0d5f2e2a240115"
},
"downloads": -1,
"filename": "llama_index_readers_obsidian-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92a54dc2cf2af14fa783efdca0d5eab6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 4310,
"upload_time": "2025-02-03T22:33:54",
"upload_time_iso_8601": "2025-02-03T22:33:54.544439Z",
"url": "https://files.pythonhosted.org/packages/1e/46/ff4e962b87f505bfe9f8fab881c0fca8b570e2800e7d4ceaf515b99981b8/llama_index_readers_obsidian-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46697d995dcf1ce8417c11b79fa39f3f4e877c0ae34606d6c8ef8071e6df257d",
"md5": "813bba2439c9fa222d721d63b55dca3f",
"sha256": "0540c66acbcf3d0e80dc6a6872908673a78bbb1b85b4d5ab6a36238adc59f1d1"
},
"downloads": -1,
"filename": "llama_index_readers_obsidian-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "813bba2439c9fa222d721d63b55dca3f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3737,
"upload_time": "2025-02-03T22:33:56",
"upload_time_iso_8601": "2025-02-03T22:33:56.478358Z",
"url": "https://files.pythonhosted.org/packages/46/69/7d995dcf1ce8417c11b79fa39f3f4e877c0ae34606d6c8ef8071e6df257d/llama_index_readers_obsidian-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-03 22:33:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-obsidian"
}