# The RelationalAI Software Development Kit for Snowflake Snowpark Python
The RelationalAI (RAI) SDK for Python enables developers to access the RAI
APIs from Snowflake Snowpark.
* You can find RelationalAI product documentation at <https://docs.relational.ai>
* You can find RelationalAI product documentation for Snowflake integration at <https://docs.relational.ai/preview/snowflake>
* You can learn more about RelationalAI at <https://relational.ai>
## Getting started
### Requirements
* Python 3.8+
### Installing the SDK
Install using pip:
```console
$ [sudo] pip install relationalai-sdk-snowflake
```
<!-- Install using conda:
```console
$ conda install -c https://repo.anaconda.com/pkgs/snowflake relationalai-sdk-snowflake
``` -->
Install from source in `editable` mode.
```console
$ git clone git@github.com:RelationalAI/rai-sdk-python.git
$ cd rai-sdk-python
$ [sudo] pip install -e relationalai-sdk-snowflake
```
### Usage
#### Prerequisites
In order to use the SDK [RelationalAI integration with Snowflake](https://docs.relational.ai/preview/snowflake) needs to be enabled.
#### Usage
Create a session according to [Snowflake Snowpark API](https://docs.snowflake.com/en/developer-guide/snowpark/python/creating-session).
```python
from snowflake.snowpark import Session
from relationalai.snowflake_sdk import api
connection_parameters = {
"user": "...",
# and any other connection parameters
}
session = Session.builder.configs(connection_parameters).create()
# Required step for RelationalAI API to be discoverable from within you current database and schema.
# Provide database and schema where RelationalAI integration has been installed into.
api.use_schema(session, "<DATABASE>.<SCHEMA>")
# See the relationalai.snowflake_sdk.api module for the list of all available APIs.
api.create_database(session, "my-database")
```
## Support
You can reach the RAI developer support team at `support@relational.ai`
## Contributing
We value feedback and contributions from our developer community. Feel free
to submit an issue or a PR here.
## License
The RelationalAI Software Development Kit for Python is licensed under the
Apache License 2.0. See:
https://github.com/RelationalAI/rai-sdk-python/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "",
"name": "relationalai-sdk-snowflake",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "RelationalAI,SDK,Snowflake,Snowpark,Python",
"author": "",
"author_email": "\"RelationalAI, Inc.\" <support@relational.ai>",
"download_url": "https://files.pythonhosted.org/packages/c7/79/c3234f86eef0bc32d9750f9f449f6b5ab39a10606d0641e628a04e3eb476/relationalai-sdk-snowflake-0.0.1.tar.gz",
"platform": null,
"description": "# The RelationalAI Software Development Kit for Snowflake Snowpark Python\n\nThe RelationalAI (RAI) SDK for Python enables developers to access the RAI\nAPIs from Snowflake Snowpark.\n\n* You can find RelationalAI product documentation at <https://docs.relational.ai>\n* You can find RelationalAI product documentation for Snowflake integration at <https://docs.relational.ai/preview/snowflake>\n* You can learn more about RelationalAI at <https://relational.ai>\n\n## Getting started\n\n### Requirements\n\n* Python 3.8+\n\n### Installing the SDK\n\nInstall using pip:\n\n```console\n$ [sudo] pip install relationalai-sdk-snowflake\n```\n\n<!-- Install using conda:\n```console\n$ conda install -c https://repo.anaconda.com/pkgs/snowflake relationalai-sdk-snowflake\n``` -->\n\nInstall from source in `editable` mode.\n\n```console\n$ git clone git@github.com:RelationalAI/rai-sdk-python.git\n$ cd rai-sdk-python\n$ [sudo] pip install -e relationalai-sdk-snowflake\n```\n\n### Usage\n\n#### Prerequisites \n\nIn order to use the SDK [RelationalAI integration with Snowflake](https://docs.relational.ai/preview/snowflake) needs to be enabled.\n\n#### Usage\n\nCreate a session according to [Snowflake Snowpark API](https://docs.snowflake.com/en/developer-guide/snowpark/python/creating-session).\n\n```python\nfrom snowflake.snowpark import Session\nfrom relationalai.snowflake_sdk import api\n\n\nconnection_parameters = {\n \"user\": \"...\",\n # and any other connection parameters\n}\n\nsession = Session.builder.configs(connection_parameters).create()\n\n# Required step for RelationalAI API to be discoverable from within you current database and schema.\n# Provide database and schema where RelationalAI integration has been installed into.\napi.use_schema(session, \"<DATABASE>.<SCHEMA>\")\n\n# See the relationalai.snowflake_sdk.api module for the list of all available APIs.\napi.create_database(session, \"my-database\")\n```\n\n## Support\n\nYou can reach the RAI developer support team at `support@relational.ai`\n\n## Contributing\n\nWe value feedback and contributions from our developer community. Feel free\nto submit an issue or a PR here.\n\n## License\n\nThe RelationalAI Software Development Kit for Python is licensed under the\nApache License 2.0. See:\nhttps://github.com/RelationalAI/rai-sdk-python/blob/master/LICENSE\n\n",
"bugtrack_url": null,
"license": "http://www.apache.org/licenses/LICENSE-2.0",
"summary": "The RelationalAI Software Development Kit for Snowflake Snowpark Python",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/RelationalAI/rai-sdk-python/tree/main/relationalai-sdk-snowflake",
"Source": "https://github.com/RelationalAI/rai-sdk-python/tree/main/relationalai-sdk-snowflake"
},
"split_keywords": [
"relationalai",
"sdk",
"snowflake",
"snowpark",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73f2e1e863568e099252e785f409da7d97233de59e3ff1ebd4a34cbac92b4351",
"md5": "119a5bda1cc209463e4ad199997a8dd1",
"sha256": "e7b8ab3f509cb2be4824abcdc189ad04f29eeb2839f8e3a62cf2e9df99303153"
},
"downloads": -1,
"filename": "relationalai_sdk_snowflake-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "119a5bda1cc209463e4ad199997a8dd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9293,
"upload_time": "2023-11-03T13:46:40",
"upload_time_iso_8601": "2023-11-03T13:46:40.361050Z",
"url": "https://files.pythonhosted.org/packages/73/f2/e1e863568e099252e785f409da7d97233de59e3ff1ebd4a34cbac92b4351/relationalai_sdk_snowflake-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c779c3234f86eef0bc32d9750f9f449f6b5ab39a10606d0641e628a04e3eb476",
"md5": "aaa3481e6ef60f1b9a99a8d0f771ef9c",
"sha256": "08f6aa5260885e57c692052a227c994ef0683702f5ece4c5b22fd009b226df57"
},
"downloads": -1,
"filename": "relationalai-sdk-snowflake-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "aaa3481e6ef60f1b9a99a8d0f771ef9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10195,
"upload_time": "2023-11-03T13:46:43",
"upload_time_iso_8601": "2023-11-03T13:46:43.319968Z",
"url": "https://files.pythonhosted.org/packages/c7/79/c3234f86eef0bc32d9750f9f449f6b5ab39a10606d0641e628a04e3eb476/relationalai-sdk-snowflake-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 13:46:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RelationalAI",
"github_project": "rai-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "grpcio",
"specs": [
[
"==",
"1.54.0"
]
]
},
{
"name": "grpcio-tools",
"specs": [
[
"==",
"1.47.0"
]
]
},
{
"name": "protobuf",
"specs": [
[
"==",
"3.20.3"
]
]
},
{
"name": "pyarrow",
"specs": [
[
"==",
"10.0.1"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"1.0.0"
]
]
}
],
"lcname": "relationalai-sdk-snowflake"
}
JSON
