Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
buremba committed Aug 5, 2024
1 parent 7e36ab8 commit 93f262d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `UniverSQL` Run Snowflake queries locally using DuckDB
# `UniverSQL` runs Snowflake queries locally on DuckDB

UniverSQL is a Snowflake proxy that allows you to run SQL queries **locally** on Snowflake Iceberg tables and Polaris catalog, using DuckDB.
You can join Snowflake data with your local datasets, **without any need for a running warehouse**.
Expand Down Expand Up @@ -30,13 +30,13 @@ sets up [filesystem](https://duckdb.org/docs/guides/python/filesystems.html) tha

# Getting Started

Install UniverSQL as a Python package:
### Python

```bash
python3 -m pip install universql
```

## Using virtual environments
#### Using virtual environments

We recommend using virtual environments (venv) to namespace pip modules. Create a new venv as follows:

Expand All @@ -51,6 +51,8 @@ source universql-env/bin/activate # activate the environment for Mac and
universql-env\Scripts\activate # activate the environment for Windows
```

### Docker

Alternatively, pull the Docker image: (recommended for running in background)

```bash
Expand Down

0 comments on commit 93f262d

Please sign in to comment.