Skip to content

Commit a1c7226

Browse files
author
Anatoli Kurtsevich
authored
RAI-15605 Snowpark-friendly Python SDK (#140)
1 parent c3d30e7 commit a1c7226

File tree

9 files changed

+991
-1
lines changed

9 files changed

+991
-1
lines changed

‎.github/workflows/publish-snowflake-sdk-pypi.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Publish RelationalAI SDK Snowflake to PyPi
2+
3+
on: workflow_dispatch
4+
5+
jobs:
6+
pypi:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout
10+
uses: actions/checkout@v3
11+
with:
12+
fetch-depth: 0
13+
- name: Build
14+
working-directory: ./relationalai-sdk-snowflake
15+
run: python3 -m pip install --upgrade build && python3 -m build
16+
- name: Publish package to PyPi
17+
uses: pypa/gh-action-pypi-publish@release/v1
18+
with:
19+
repository-url: https://test.pypi.org/legacy/
20+
packages-dir: ./relationalai-sdk-snowflake/dist
21+
user: __token__
22+
password: ${{ secrets.TESTPYPI_API_TOKEN }}

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ __pycache__
66
build/
77
dist/
88
env/
9-
rai_sdk.egg-info/
9+
*.egg-info/

‎relationalai-sdk-snowflake/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎relationalai-sdk-snowflake/README.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# The RelationalAI Software Development Kit for Snowflake Snowpark Python
2+
3+
The RelationalAI (RAI) SDK for Python enables developers to access the RAI
4+
APIs from Snowflake Snowpark.
5+
6+
* You can find RelationalAI product documentation at <https://docs.relational.ai>
7+
* You can find RelationalAI product documentation for Snowflake integration at <https://docs.relational.ai/preview/snowflake>
8+
* You can learn more about RelationalAI at <https://relational.ai>
9+
10+
## Getting started
11+
12+
### Requirements
13+
14+
* Python 3.8+
15+
16+
### Installing the SDK
17+
18+
Install using pip:
19+
20+
```console
21+
$ [sudo] pip install relationalai-sdk-snowflake
22+
```
23+
24+
<!-- Install using conda:
25+
```console
26+
$ conda install -c https://repo.anaconda.com/pkgs/snowflake relationalai-sdk-snowflake
27+
``` -->
28+
29+
Install from source in `editable` mode.
30+
31+
```console
32+
$ git clone git@github.com:RelationalAI/rai-sdk-python.git
33+
$ cd rai-sdk-python
34+
$ [sudo] pip install -e relationalai-sdk-snowflake
35+
```
36+
37+
### Usage
38+
39+
#### Prerequisites
40+
41+
In order to use the SDK [RelationalAI integration with Snowflake](https://docs.relational.ai/preview/snowflake) needs to be enabled.
42+
43+
#### Usage
44+
45+
Create a session according to [Snowflake Snowpark API](https://docs.snowflake.com/en/developer-guide/snowpark/python/creating-session).
46+
47+
```python
48+
from snowflake.snowpark import Session
49+
from relationalai.snowflake_sdk import api
50+
51+
52+
connection_parameters = {
53+
"user": "...",
54+
# and any other connection parameters
55+
}
56+
57+
session = Session.builder.configs(connection_parameters).create()
58+
59+
# Required step for RelationalAI API to be discoverable from within you current database and schema.
60+
# Provide database and schema where RelationalAI integration has been installed into.
61+
api.use_schema(session, "<DATABASE>.<SCHEMA>")
62+
63+
# See the relationalai.snowflake_sdk.api module for the list of all available APIs.
64+
api.create_database(session, "my-database")
65+
```
66+
67+
## Support
68+
69+
You can reach the RAI developer support team at `support@relational.ai`
70+
71+
## Contributing
72+
73+
We value feedback and contributions from our developer community. Feel free
74+
to submit an issue or a PR here.
75+
76+
## License
77+
78+
The RelationalAI Software Development Kit for Python is licensed under the
79+
Apache License 2.0. See:
80+
https://github.com/RelationalAI/rai-sdk-python/blob/master/LICENSE
81+

‎relationalai-sdk-snowflake/pyproject.toml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
[build-system]
2+
requires = ["setuptools", "setuptools-scm"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[tool.setuptools.packages.find]
6+
where = ["."]
7+
include = ["relationalai"]
8+
namespaces = true
9+
10+
[project]
11+
name = "relationalai-sdk-snowflake"
12+
description = "The RelationalAI Software Development Kit for Snowflake Snowpark Python"
13+
license = { text = "http://www.apache.org/licenses/LICENSE-2.0" }
14+
readme = "README.md"
15+
keywords = ["RelationalAI", "SDK", "Snowflake", "Snowpark", "Python"]
16+
authors = [
17+
{name = "RelationalAI, Inc.", email = "support@relational.ai"},
18+
]
19+
classifiers = [
20+
"Development Status :: 3 - Alpha",
21+
"Intended Audience :: Developers",
22+
"Intended Audience :: Information Technology",
23+
"Intended Audience :: System Administrators",
24+
"License :: OSI Approved :: Apache Software License",
25+
"Natural Language :: English",
26+
"Operating System :: OS Independent",
27+
"Programming Language :: Python :: 3 :: Only",
28+
"Programming Language :: Python :: 3.10",
29+
"Programming Language :: Python :: 3.11",
30+
"Programming Language :: Python :: 3.12",
31+
"Programming Language :: Python :: 3.8",
32+
"Programming Language :: Python :: 3.9",
33+
"Programming Language :: Python :: 3",
34+
"Topic :: Database",
35+
"Topic :: Scientific/Engineering :: Information Analysis",
36+
"Topic :: Software Development :: Libraries :: Application Frameworks",
37+
"Topic :: Software Development :: Libraries :: Python Modules",
38+
"Topic :: Software Development :: Libraries",
39+
"Topic :: Software Development",
40+
]
41+
requires-python = ">=3.8"
42+
dependencies = ["snowflake-snowpark-python"]
43+
dynamic = ["version"]
44+
45+
[project.urls]
46+
"Homepage" = "https://github.com/RelationalAI/rai-sdk-python/tree/main/relationalai-sdk-snowflake"
47+
"Source" = "https://github.com/RelationalAI/rai-sdk-python/tree/main/relationalai-sdk-snowflake"
48+
49+
[tool.setuptools.dynamic]
50+
version = {attr = "relationalai.snowflake_sdk.__version__"}

‎relationalai-sdk-snowflake/relationalai/snowflake_sdk/__init__.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Copyright 2021 RelationalAI, Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
__version_info__ = (0, 0, 1)
16+
__version__ = ".".join(map(str, __version_info__))

0 commit comments

Comments
 (0)