snowflake-cli-labs 3.0.0rc0__tar.gz → 3.0.0rc2__tar.gz

snowflake_cli_labs-3.0.0rc2/CONTRIBUTING.md

@@ -0,0 +1,243 @@
+<!--
+ Copyright (c) 2024 Snowflake Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Contributing to Snowflake CLI
+
+There are two ways to contribute code to the repository: directly or by use of forks. For best practices for the second approach, refer to the section on forks below. Right now, there is limited access to contributing to the repository directly, and hence using forks is the recommended approach.
+
+## Setup a development environment
+If you are interested in contributing, you will need to instantiate dev virtual environments and the pre-commit logic to help with formatting and linting of commits.
+
+We use [hatch](https://hatch.pypa.io/latest/) to manage and created development environments.
+Default environment will use the python version in your shell.
+```bash
+pip install -U hatch
+hatch run pre-commit
+```
+This will spawn new shell with environment and all required packages installed.
+This will also install snowflake cli package in editable mode.
+
+To enter environment use following command.
+```bash
+hatch shell
+```
+This will spawn new shell with virtual environment enables. To leave just press ^D.
+
+
+Currently, the required Python version for development is Python 3.10+. For local development we recommend to use
+a wrapper for virtual environments like [pyenv](https://github.com/pyenv/pyenv).
+
+If you wish to setup environment with specific version ie. 3.10 you can use following command:
+
+```bash
+hatch env create local.py3.10```
+
+You can see all locally supported environments with
+
+```bash
+hatch env show
+```
+
+Please keep in mind that you need these python versions available in your `$PATH`. You can install them using `hatch` or other tool like [pyenv](https://github.com/pyenv/pyenv)
+
+## Unit tests
+
+Unit tests are executed in random order. If tests fail after your change, you can re-execute them in the same order using `pytest --randomly-seed=<number>`, where number is a seed printed at the beginning of the test execution output.
+Random order of test execution is provided by pytest-randomly, so more details are available in [pytest-randomly docs](https://pypi.org/project/pytest-randomly/).
+
+```bash
+hatch run test
+```
+or by running `pytest` inside activated environment.
+
+
+## Integration tests
+
+Every integration test should have `integration` mark. By default, integration tests are not execute when running `pytest`.
+
+To execute only integration tests run `hatch run integration:test` or `pytest -m integration` inside environment.
+
+### User setup
+
+Integration tests require environment variables to be set up. Parameters must use the following format:
+
+``SNOWFLAKE_CONNECTIONS_INTEGRATION_<key>=<value>``
+
+where ``<key>`` is the name of the key. The following environment variables are required:
+
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_AUTHENTICATOR=SNOWFLAKE_JWT`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_HOST`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_ACCOUNT`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_USER`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_PRIVATE_KEY_RAW` (Loads the private key directly from the environment variable)
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_ROLE`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_DATABASE`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_WAREHOUSE`
+
+### Integration account setup script
+
+To set up an account for integration tests, run the following script with `ACCOUNTADMIN` role:
+
+```bash
+snow sql \
+  -f tests_integration/scripts/integration_account_setup.sql \
+  -D "user=${SNOWFLAKE_CONNECTIONS_INTEGRATION_USER}" \
+  -D "role=${SNOWFLAKE_CONNECTIONS_INTEGRATION_ROLE}" \
+  -D "warehouse=${SNOWFLAKE_CONNECTIONS_INTEGRATION_WAREHOUSE}" \
+  -D "main_database=${SNOWFLAKE_CONNECTIONS_INTEGRATION_DATABASE}"\
+  -c <your_connection_name>
+```
+
+Note: Before running the script, set up your environment variables.
+
+### Build and push Docker images
+
+To build and push all required Docker images, run the following script:
+
+```bash
+./tests_integration/spcs/docker/build_and_push_all.sh
+```
+
+## Remote debugging with PyCharm or IntelliJ
+
+Snowflake CLI can connect to a remote debug server started in PyCharm or Intellij.
+It allows you to debug any installation of our tool in one of mentioned IDEs.
+
+There are only three requirements:
+* the same source code loaded in your IDE as running in the debugged CLI installation
+* open network connection to your IDE
+* `pydevd-pycharm.egg` file accessible on the machine where the CLI is installed (the file has to match the version of your IDE)
+
+How to use it?
+1. Create a "remote debug config" run configuration in your IDE.
+    * Steps 1-2 from [this tutorial from JetBrains](https://www.jetbrains.com/help/pycharm/remote-debugging-with-product.html#create-remote-debug-config).
+    * `localhost` and `12345` port are defaults both in the IDE and in the CLI.
+1. Run your new configuration in debug mode.
+1. Find `pydevd-pycharm.egg` in the directory where your IDE is installed.
+    * Some tips how to find it should be present in the following places:
+      * The instruction from JetBrains linked above.
+      * The "remote debug config" creation window.
+1. If the CLI and the IDE are on the same machine, you have to just copy the path to the file.
+1. If the CLI is on another machine, then you have to copy the file there and also copy the target file path.
+1. Run the CLI using `snow --pycharm-debug-library-path <path-to-pydevd-pycharm.egg> <other-options-and-command>`.
+    * Example: `snow --pycharm-debug-library-path "/Users/xyz/Library/Application Support/JetBrains/Toolbox/apps/IDEA-U/ch-0/231.9011.34/IntelliJ IDEA.app.plugins/python/debugger-eggs-output/pydevd-pycharm.egg" snowpark function list`
+    * The CLI will try to connect to your debug server (by default to `localhost:12345`).
+    * If a connection cannot be established, you will see some exception about it.
+    * If you want to use other host or port you can use `--pycharm-debug-server-host` and `--pycharm-debug-server-port` options.
+    * The code execution will be paused before execution of your command.
+      You will see the exact line in the IDE's debug view.
+      You can resume code execution, add breakpoints, evaluate variables, do all the things you usually do when debugging locally.
+
+## Using Forks
+Create your own fork from the `snowflake-cli` repo. As a heads up, all `snowflake-cli` forks are publicly accessible on Github.
+
+Syncing forks with the upstream `snowflake-cli` repo can be a hassle when trying to resolve merge conflicts. To avoid issues with this approach, we recommend always rebasing to the upstream `snowflake-cli` branch.
+
+In the cloned copy of your fork, perform the following steps.
+
+```bash
+git remote add sfcli https://github.com/snowflakedb/snowflake-cli.git
+git fetch sfcli
+git checkout <your-branch>
+git rebase sfcli/main
+```
+
+## Presenting intermediate output to users
+
+Snowflake CLI enables users to interact with the Snowflake ecosystem using command line. Some commands provide immediate results, while others require some amount of operations to be executed before the result can be presented to the user.
+
+Presenting intermediate output to the user during execution of complex commands can improve users' experience.
+
+Since snowflake-cli is preparing to support additional commands via plugins, it is the right time to introduce a unified mechanism for displaying intermediate output. This will help keep consistent output among cli and plugins. There is no way to restrain usage of any kind of output in plugins developed in external repositories, but providing api may discourage others from introducing custom output.
+
+The proposal is to introduce cli_console object that will provide following helper methods to interact with the output:
+step - a method for printing regular output
+warning - a method for printing messages that should be
+phase - a context manager that will group all output within its scope as distinct unit
+
+Implemented CliConsole class must respect parameter `–silent` and disable any output when requested.
+
+Context manager must allow only one grouping level at a time. All subsequent invocations will result in raising `CliConsoleNestingProhibitedError` derived from `RuntimeError`.
+
+Logging support
+All messages handled by CliConsole may be logged regardless of is_silent property.
+
+### Example usage
+
+#### Simple output
+
+```python
+from snowflake.cli.api.console import cli_console as cc
+
+def my_command():
+    cc.step("Some work...")
+    ...
+    cc.step("Next work...")
+```
+
+#### Output
+
+```bash
+> snow my_command
+
+Some work...
+Next work...
+```
+
+#### Grouped output
+
+```python
+from snowflake.cli.api.console import cli_console as cc
+
+def my_command():
+    cc.step("Building and publishing the application")
+    prepare_data_for_processing()
+
+    with cc.phase(
+      enter_message="Building app bundle...",
+      exit_message="Application bundle created.",
+    ):
+        try:
+          cc.step("Building package artifact")
+          make_archive_bundle()
+        except BundleSizeWarning:
+          cc.warning("Bundle size is large. It may take some time to upload.")
+
+        cc.step("Uploading bundle")
+        upload_bundle()
+
+    cc.step("Publishing application")
+    publish_application()
+```
+
+#### Output
+
+```bash
+> snow my_command
+
+Building and publishing the application
+Building app bundle...
+  Building package artifact
+  __Bundle size is large. It may take some time to upload.__
+  Uploading bundle
+Application bundle created.
+Publishing application
+```
+
+## Known issues
+
+### `permission denied` during integration tests on Windows
+This error occurs when using NamedTemporaryFile and try to open it second time https://docs.python.org/3/library/tempfile.html#tempfile.NamedTemporaryFile

snowflake_cli_labs-3.0.0rc2/PKG-INFO

@@ -0,0 +1,323 @@
+Metadata-Version: 2.3
+Name: snowflake-cli-labs
+Version: 3.0.0rc2
+Summary: Snowflake CLI
+Project-URL: Source code, https://github.com/snowflakedb/snowflake-cli
+Project-URL: Bug Tracker, https://github.com/snowflakedb/snowflake-cli/issues
+Author: Snowflake Inc.
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2024 Snowflake Inc.
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: SQL
+Classifier: Topic :: Database
+Requires-Python: >=3.10
+Requires-Dist: gitpython==3.1.43
+Requires-Dist: jinja2==3.1.4
+Requires-Dist: packaging
+Requires-Dist: pip
+Requires-Dist: pluggy==1.5.0
+Requires-Dist: pydantic==2.9.1
+Requires-Dist: pyyaml==6.0.2
+Requires-Dist: requests==2.32.3
+Requires-Dist: requirements-parser==0.11.0
+Requires-Dist: rich==13.8.0
+Requires-Dist: setuptools==74.1.2
+Requires-Dist: snowflake-connector-python[secure-local-storage]==3.12.1
+Requires-Dist: snowflake-core==0.8.0; python_version < '3.12'
+Requires-Dist: snowflake-snowpark-python>=1.15.0; python_version < '3.12'
+Requires-Dist: tomlkit==0.13.2
+Requires-Dist: typer==0.12.5
+Requires-Dist: urllib3<2.3,>=1.24.3
+Provides-Extra: development
+Requires-Dist: coverage==7.6.1; extra == 'development'
+Requires-Dist: pre-commit>=3.5.0; extra == 'development'
+Requires-Dist: pytest-randomly==3.15.0; extra == 'development'
+Requires-Dist: pytest==8.3.2; extra == 'development'
+Requires-Dist: syrupy==4.7.1; extra == 'development'
+Description-Content-Type: text/markdown
+
+<!--
+ Copyright (c) 2024 Snowflake Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+[![Code quality checks](https://github.com/snowflakedb/snowflake-cli/actions/workflows/lint.yaml/badge.svg)](https://github.com/snowflakedb/snowflake-cli/actions/workflows/lint.yaml)
+[![Integration testing](https://github.com/snowflakedb/snowflake-cli/actions/workflows/integration_test.yaml/badge.svg)](https://github.com/snowflakedb/snowflake-cli/actions/workflows/integration_test.yaml)
+[![CLI Action testing](https://github.com/snowflakedb/snowflake-cli/actions/workflows/test_cli_action.yaml/badge.svg?branch=main)](https://github.com/snowflakedb/snowflake-cli/actions/workflows/test_cli_action.yaml)
+
+[//]: # ([![Python 3.11]&#40;https://img.shields.io/badge/python-3.11-blue.svg&#41;]&#40;https://www.python.org/downloads/release/python-311/&#41;)
+
+# Snowflake CLI
+
+Snowflake CLI is an open-source command-line tool explicitly designed for developer-centric workloads in addition to SQL operations. It is a flexible and extensible tool that can accommodate modern development practices and technologies.
+
+With Snowflake CLI, developers can create, manage, update, and view apps running on Snowflake across workloads such as Streamlit in Snowflake, the Snowflake Native App Framework, Snowpark Container Services, and Snowpark. It supports a range of Snowflake features, including user-defined functions, stored procedures, Streamlit in Snowflake, and SQL execution.
+
+
+**Note**: Snowflake CLI is in Public Preview (PuPr).
+
+Docs: https://docs.snowflake.com/en/developer-guide/snowflake-cli-v2/index.
+
+Quick start: https://quickstarts.snowflake.com/guide/getting-started-with-snowflake-cli
+
+Cheatsheet: https://github.com/Snowflake-Labs/sf-cheatsheets/blob/main/snowflake-cli.md
+
+
+## Install Snowflake CLI
+
+### Install with pipx (PyPi)
+
+We recommend installing Snowflake CLI in isolated environment using [pipx](https://pipx.pypa.io/stable/). Requires Python >= 3.10
+
+```bash
+pipx install snowflake-cli-labs
+snow --help
+```
+
+### Install with Homebrew (Mac only)
+
+Requires [Homebrew](https://brew.sh/).
+
+```bash
+brew tap snowflakedb/snowflake-cli
+brew install snowflake-cli
+snow --help
+```
+
+### Install from source
+
+Requires Python >= 3.10 and git
+
+```bash
+git clone https://github.com/snowflakedb/snowflake-cli
+cd snowflake-cli
+# you can also do the below in an active virtual environment:
+# python -m venv .venv
+# source .venv/bin/activate
+hatch build && pip install .
+snow --version
+```
+
+You should now be able to run `snow` and get the CLI message.
+
+## Get involved
+
+Have a feature idea? Running into a bug? Want to contribute? We'd love to hear from you!
+Please open or review issues, open pull requests, or reach out to us on developers@snowflake.com