llama-index-readers-obsidian


Namellama-index-readers-obsidian JSON
Version 0.4.0 PyPI version JSON
download
home_pageNone
Summaryllama-index readers obsidian integration
upload_time2024-11-18 01:06:02
maintainerhursh-desai
docs_urlNone
authorYour Name
requires_python<4.0,>=3.9
licenseMIT
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.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/a0/0c/9e1c7605cbb5889ad815af3f239213b56f2d3b56bc0fbe14d55f1a59afbe/llama_index_readers_obsidian-0.4.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.4.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "71f8e3f0c16619ef79c07c241289f1175c9918d0f1bcbec5511f00f1c9ee3f6e",
                "md5": "064ebf5ecf30830a9cd6ef6391ffdc8f",
                "sha256": "7e1158d0154c169a9beaeca6106a8b8783b460ecfb2fc518d07c58125d11d1bc"
            },
            "downloads": -1,
            "filename": "llama_index_readers_obsidian-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "064ebf5ecf30830a9cd6ef6391ffdc8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 2703,
            "upload_time": "2024-11-18T01:06:00",
            "upload_time_iso_8601": "2024-11-18T01:06:00.769636Z",
            "url": "https://files.pythonhosted.org/packages/71/f8/e3f0c16619ef79c07c241289f1175c9918d0f1bcbec5511f00f1c9ee3f6e/llama_index_readers_obsidian-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a00c9e1c7605cbb5889ad815af3f239213b56f2d3b56bc0fbe14d55f1a59afbe",
                "md5": "13113b30ee4eb0abf5135acdae0d1331",
                "sha256": "39681ce68c4c1dee8c7b1b14622a6ffceda12b771483df737f3a6247821d814b"
            },
            "downloads": -1,
            "filename": "llama_index_readers_obsidian-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "13113b30ee4eb0abf5135acdae0d1331",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 2396,
            "upload_time": "2024-11-18T01:06:02",
            "upload_time_iso_8601": "2024-11-18T01:06:02.247765Z",
            "url": "https://files.pythonhosted.org/packages/a0/0c/9e1c7605cbb5889ad815af3f239213b56f2d3b56bc0fbe14d55f1a59afbe/llama_index_readers_obsidian-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-18 01:06:02",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-obsidian"
}
        
Elapsed time: 0.49558s