Skip to content

Commit 521c595

Browse files
author
Charles Larivier
committed
docs: update README
Signed-off-by: Charles Larivier <charles@dribbble.com>
1 parent ddd18f6 commit 521c595

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
An unofficial Python library for the [Metabase API](https://www.metabase.com/learn/administration/metabase-api).
77

8-
This API is still experimental and may change significantly between minor versions.
98

109
## Installation
1110

@@ -14,6 +13,8 @@ pip install metabase-python
1413
```
1514

1615
## Usage
16+
This API is still experimental and may change significantly between minor versions.
17+
1718

1819
Start by creating an instance of Metabase with your credentials. This connection will automatically be used by any
1920
object that interacts with the Metabase API.
@@ -27,7 +28,8 @@ metabase = Metabase(
2728
)
2829
```
2930

30-
You can then interact with any of the supported endpoints. All changes are reflected in Metabase instantly.
31+
You can then interact with any of the supported endpoints through the classes included in this package. All changes
32+
are reflected in Metabase instantly.
3133

3234
```python
3335
from metabase import User
@@ -87,7 +89,7 @@ for user in User.list():
8789
```
8890

8991
You can also execute queries and get results back as a Pandas DataFrame. Currently, you need to provide
90-
the exact MBQL (i.e. Metabase Query Language) as the `query` argument -- future iterations will improve this workflow.
92+
the exact MBQL (i.e. Metabase Query Language) as the `query` argument.
9193
```python
9294
from metabase import Dataset
9395

0 commit comments

Comments
 (0)