Skip to content

Commit

Permalink
Add install and usage sections to README (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrbourbeau authored Sep 14, 2021
1 parent 49ca027 commit e7977e5
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,57 @@ This connector is in an early experimental/testing phase.

[Reach out to us](https://coiled.io/contact-us/) if you are interested in trying
it out!

## Installation

`dask-snowflake` can be installed with `pip`:

```
pip install dask-snowflake
```

or with `conda`:

```
conda install -c conda-forge dask-snowflake
```

## Usage

`dask-snowflake` provides `read_snowflake` and `to_snowflake` methods
for parallel IO from Snowflake with Dask.

```python
>>> from dask_snowflake import read_snowflake
>>> example_query = '''
... SELECT *
... FROM SNOWFLAKE_SAMPLE_DATA.TPCH_SF1.CUSTOMER;
... '''
>>> ddf = read_snowflake(
... query=example_query,
... connection_kwargs={
... "user": "...",
... "password": "...",
... "account": "...",
... },
... )
```

```python
>>> from dask_snowflake import to_snowflake
>>> to_snowflake(
... ddf,
... name="my_table",
... connection_kwargs={
... "user": "...",
... "password": "...",
... "account": "...",
... },
... )
```

See their docstrings for further API information.

## License

[BSD-3](LICENSE)

0 comments on commit e7977e5

Please # to comment.