Skip to content

Commit c87100c

Browse files
committed
Update README
1 parent 384a362 commit c87100c

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# BoilingData Client for Python
22

3+
```shell
4+
pip install git+https://github.com/boilingdata/py-boilingdata
5+
```
6+
37
A python client for sending SQL queries and receive results from BoilingData WebSockets API.
48

59
- This package uses `asyncio` and `threads` to make the `websocket.WebSocketApp()` run on the background.
@@ -31,12 +35,13 @@ loop = asyncio.get_event_loop()
3135
loop.run_until_complete(main())
3236
```
3337

34-
## Build and Install
38+
## Development
3539

3640
```shell
3741
make install
3842
make build
39-
# make lint
40-
# make test
43+
make lint
44+
make test
45+
make run
4146
pip install dist/py_boilingdata-*-py3-none-any.whl
4247
```

0 commit comments

Comments
 (0)