whyhow


Namewhyhow JSON
Version 0.1.9 PyPI version JSON
download
home_pageNone
SummaryWhyhow automated KG SDK
upload_time2024-11-14 17:20:35
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords sdk kg
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # WhyHow Knowledge Graph Studio SDK

[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/licenses/MIT)
[![PyPI Version](https://img.shields.io/pypi/v/whyhow)](https://pypi.org/project/whyhow/)
[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue)](https://mypy-lang.org/)
<a href="https://discord.gg/9bWqrsxgHr" alt="WhyHow Discord community">
<picture>
  <img alt="WhyHow Discord community" src="https://invidget.switchblade.xyz/9bWqrsxgHr?theme=dark">
</picture>
</a>

The WhyHow Knowledge Graph Studio SDK enables you to quickly and easily build automated knowledge graphs tailored to your unique worldview. Instantly build, extend, and query well-scoped KGs with your data.

> [!WARNING]
> This SDK is our old SDK. To access our upgraded Sutdio Platform, please check out our [upgraded Studio & SDK here](https://medium.com/enterprise-rag/whyhow-ai-platform-beta-update-sdk-for-programmatic-flows-a0e33921416a).

# Installation

## Prerequisites

- Python 3.10 or higher

## Install from PyPI

You can install the SDK directly from PyPI using pip:

```shell
pip install whyhow

export WHYHOW_API_KEY=<YOUR_WHYHOW_API_KEY>
```

## Install from Github

Alternatively, you can clone the repo and install the package

```shell

git clone git@github.com:whyhow-ai/whyhow.git
cd whyhow
pip install .

export WHYHOW_API_KEY=<YOUR_WHYHOW_API_KEY>
```

# Examples

Navigate to the `examples/`.

## Initialize SDK

Import the SDK and initialize the client using your WhyHow API key.

```shell
from whyhow import WhyHow

client = WhyHow(api_key=<your whyhow api key>, base_url="https://api.whyhow.ai")
```

### Support

WhyHow.AI is building tools to help developers bring more determinism and control to their RAG pipelines using graph structures. If you're thinking about, in the process of, or have already incorporated knowledge graphs in RAG, we’d love to chat at team@whyhow.ai, or follow our newsletter at [WhyHow.AI](https://www.whyhow.ai/). Join our discussions about rules, determinism and knowledge graphs in RAG on our [Discord](https://discord.com/invite/9bWqrsxgHr).

We appreciate your interest.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "whyhow",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "SDK, KG",
    "author": null,
    "author_email": "Tom Smoker <tom@whyhow.ai>, Chris Rec <chris@whyhow.ai>",
    "download_url": "https://files.pythonhosted.org/packages/ad/8f/24063f924fa91c534cdcd995b77cbc203768a9f876fcc6bcc17e14d2f800/whyhow-0.1.9.tar.gz",
    "platform": null,
    "description": "# WhyHow Knowledge Graph Studio SDK\n\n[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)\n[![License](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/licenses/MIT)\n[![PyPI Version](https://img.shields.io/pypi/v/whyhow)](https://pypi.org/project/whyhow/)\n[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue)](https://mypy-lang.org/)\n<a href=\"https://discord.gg/9bWqrsxgHr\" alt=\"WhyHow Discord community\">\n<picture>\n  <img alt=\"WhyHow Discord community\" src=\"https://invidget.switchblade.xyz/9bWqrsxgHr?theme=dark\">\n</picture>\n</a>\n\nThe WhyHow Knowledge Graph Studio SDK enables you to quickly and easily build automated knowledge graphs tailored to your unique worldview. Instantly build, extend, and query well-scoped KGs with your data.\n\n> [!WARNING]\n> This SDK is our old SDK. To access our upgraded Sutdio Platform, please check out our [upgraded Studio & SDK here](https://medium.com/enterprise-rag/whyhow-ai-platform-beta-update-sdk-for-programmatic-flows-a0e33921416a).\n\n# Installation\n\n## Prerequisites\n\n- Python 3.10 or higher\n\n## Install from PyPI\n\nYou can install the SDK directly from PyPI using pip:\n\n```shell\npip install whyhow\n\nexport WHYHOW_API_KEY=<YOUR_WHYHOW_API_KEY>\n```\n\n## Install from Github\n\nAlternatively, you can clone the repo and install the package\n\n```shell\n\ngit clone git@github.com:whyhow-ai/whyhow.git\ncd whyhow\npip install .\n\nexport WHYHOW_API_KEY=<YOUR_WHYHOW_API_KEY>\n```\n\n# Examples\n\nNavigate to the `examples/`.\n\n## Initialize SDK\n\nImport the SDK and initialize the client using your WhyHow API key.\n\n```shell\nfrom whyhow import WhyHow\n\nclient = WhyHow(api_key=<your whyhow api key>, base_url=\"https://api.whyhow.ai\")\n```\n\n### Support\n\nWhyHow.AI is building tools to help developers bring more determinism and control to their RAG pipelines using graph structures. If you're thinking about, in the process of, or have already incorporated knowledge graphs in RAG, we\u2019d love to chat at team@whyhow.ai, or follow our newsletter at [WhyHow.AI](https://www.whyhow.ai/). Join our discussions about rules, determinism and knowledge graphs in RAG on our [Discord](https://discord.com/invite/9bWqrsxgHr).\n\nWe appreciate your interest.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Whyhow automated KG SDK",
    "version": "0.1.9",
    "project_urls": {
        "Homepage": "https://github.com/whyhow-ai/whyhow"
    },
    "split_keywords": [
        "sdk",
        " kg"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a39cce064ab8ee86c5b634d29ad63879c5e1ea17af9af6a786b242f7b1c83c9c",
                "md5": "b630b5520cde63c0f9c3063fa8aaaa05",
                "sha256": "c7e61d31aa4a9d0afe7d5f8dee6957fc4c7a292378896a7f40e9cfd66cd094ab"
            },
            "downloads": -1,
            "filename": "whyhow-0.1.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b630b5520cde63c0f9c3063fa8aaaa05",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 56604,
            "upload_time": "2024-11-14T17:20:34",
            "upload_time_iso_8601": "2024-11-14T17:20:34.008844Z",
            "url": "https://files.pythonhosted.org/packages/a3/9c/ce064ab8ee86c5b634d29ad63879c5e1ea17af9af6a786b242f7b1c83c9c/whyhow-0.1.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad8f24063f924fa91c534cdcd995b77cbc203768a9f876fcc6bcc17e14d2f800",
                "md5": "d55ba9208cf5036ab5fcb5812e9f30a9",
                "sha256": "0068830a8f8ebb31d295c04fdcda3a1ba915b95e834717e032b41fe2b5694bc7"
            },
            "downloads": -1,
            "filename": "whyhow-0.1.9.tar.gz",
            "has_sig": false,
            "md5_digest": "d55ba9208cf5036ab5fcb5812e9f30a9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 47007,
            "upload_time": "2024-11-14T17:20:35",
            "upload_time_iso_8601": "2024-11-14T17:20:35.439221Z",
            "url": "https://files.pythonhosted.org/packages/ad/8f/24063f924fa91c534cdcd995b77cbc203768a9f876fcc6bcc17e14d2f800/whyhow-0.1.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-14 17:20:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "whyhow-ai",
    "github_project": "whyhow",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "whyhow"
}
        
Elapsed time: 1.23324s