llama-index-readers-obsidian

Name	llama-index-readers-obsidian JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	llama-index readers obsidian integration
upload_time	2024-08-22 14:29:09
maintainer	hursh-desai
docs_url	None
author	Your Name
requires_python	<4.0,>=3.8.1
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

Obsidian Reader is a utility class for loading data from an Obsidian Vault. It parses all markdown files in the vault and extracts text from under Obsidian headers, returning a list of documents, each containing text from a separate header.

### 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>")

# Load data from the Obsidian vault
documents = reader.load_data()
```

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": "hursh-desai",
    "docs_url": null,
    "requires_python": "<4.0,>=3.8.1",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/e1/d2/981d7a5bb2c700ebdb9978abf8855a574aad16e70463f350f084d603fb5c/llama_index_readers_obsidian-0.2.0.tar.gz",
    "platform": null,
    "description": "# LlamaIndex Readers Integration: Obsidian\n\n## Overview\n\nObsidian Reader is a utility class for loading data from an Obsidian Vault. It parses all markdown files in the vault and extracts text from under Obsidian headers, returning a list of documents, each containing text from a separate header.\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(input_dir=\"<Path to Obsidian Vault>\")\n\n# Load data from the Obsidian vault\ndocuments = reader.load_data()\n```\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.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a336cf19886df4760ab4f5686bd3458299c83cd9a7145ac51bd243fe989d9ad",
                "md5": "bf6abced91d60ef36afd8830701350b3",
                "sha256": "f9a00d674c71dd6fbb6263b9f43ba642598309fdf4e9330ae8287ea7d9f760df"
            },
            "downloads": -1,
            "filename": "llama_index_readers_obsidian-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bf6abced91d60ef36afd8830701350b3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 2708,
            "upload_time": "2024-08-22T14:29:08",
            "upload_time_iso_8601": "2024-08-22T14:29:08.495513Z",
            "url": "https://files.pythonhosted.org/packages/0a/33/6cf19886df4760ab4f5686bd3458299c83cd9a7145ac51bd243fe989d9ad/llama_index_readers_obsidian-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e1d2981d7a5bb2c700ebdb9978abf8855a574aad16e70463f350f084d603fb5c",
                "md5": "15086b7a281bd4ae578e3dbe7fdc505e",
                "sha256": "1c5e9cc86fd1cc1d96a1e1e88106945da342c04b2a409b5175b965c85057a34f"
            },
            "downloads": -1,
            "filename": "llama_index_readers_obsidian-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "15086b7a281bd4ae578e3dbe7fdc505e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 2436,
            "upload_time": "2024-08-22T14:29:09",
            "upload_time_iso_8601": "2024-08-22T14:29:09.903523Z",
            "url": "https://files.pythonhosted.org/packages/e1/d2/981d7a5bb2c700ebdb9978abf8855a574aad16e70463f350f084d603fb5c/llama_index_readers_obsidian-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 14:29:09",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-obsidian"
}