Skip to content

Commit

Permalink
Adjust README to mention rename
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-turbaszek committed Jan 30, 2024
1 parent a37f3d9 commit 21a6336
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 49 deletions.
50 changes: 2 additions & 48 deletions compat/snowflake-cli-labs/README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,5 @@
# Snowflake Developer CLI

**Note**: Snowflake CLI is in Private Preview (PrPr). You must register for the PrPr to use Snowflake CLI by filling out the
[Snowflake CLI - PrPr Intake Form](https://forms.gle/HZNhPNbzn7oExjFu8). Also, if you want to access Snowflake Container
Services through Snowflake CLI, you must register for its PrPr. For more information, you can contact a
Snowflake sales representative.
This package has been renamed. Use `pip install snowflake-cli` instead.

For complete installation and usage instructions, refer to the
**[Snowflake CLI Guide](https://docs.snowflake.com/LIMITEDACCESS/snowcli/snowcli-guide)**.

## Install Snowflake CLI

### Install with pip (PyPi)

Requires Python >= 3.8

```bash
pip install snowflake-cli
snow --help
```

### Install with Homebrew (Mac only)

Requires [Homebrew](https://brew.sh/).

```bash
brew tap Snowflake-Labs/snowcli
brew install snowcli
snow --help
```

### Install from source

Requires Python >= 3.8 and git

```bash
git clone https://github.com/snowflake-labs/snowcli
cd snowcli
# 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 [email protected]
New package: https://pypi.org/project/snowflake-cli/
5 changes: 4 additions & 1 deletion compat/snowflake-cli-labs/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "hatchling.build"
name = "snowflake-cli-labs"
authors = [{ name = "Snowflake Inc." }]
license = { file = "LICENSE" }
version = "2.0.0"
dynamic = ["version"]
requires-python = ">=3.8"
description = "Snowflake CLI"
readme = "README.md"
Expand All @@ -21,3 +21,6 @@ classifiers = [

[tool.hatch.build.targets.wheel]
packages = ["README.md"]

[tool.hatch.version]
path = "../../src/snowflake/cli/__about__.py"

0 comments on commit 21a6336

Please sign in to comment.