Skip to content

Commit

Permalink
update readme for catalog
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbertDeFusco committed Feb 8, 2021
1 parent e9aea82 commit 8246835
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,35 @@ conda install -c defusco intake-metabase


## Quickstart
To access a catalog of tables in Metabase you will need the following information

* `domain`: The URL where Metabase is running
* `username`: Your username, typically an email address
* `password`: Your password (Google Auth is not yet supported)

To load the catalog and list the tables

```python
import intake
catalog = intake.open_metabase_catalog(domain, username, password)
list(catalog)
```

This will produce output like

```
[table1, table2, table3]
```

To load a table as a Pandas DataFrame

```
df = catalog.<table>.read()
```

Replace `<table>` with the name of the table from the list.

## Load a single table
To load a table as a Pandas DataFrames you will need to know the following information

* `domain`: The URL where Metabase is running
Expand Down

0 comments on commit 8246835

Please sign in to comment.