Skip to content

Commit

Permalink
Mention about the soft requirement for pandas
Browse files Browse the repository at this point in the history
  • Loading branch information
abhinav-upadhyay authored Feb 14, 2019
1 parent d00f10b commit c5e3c2e
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ pip install apptuit --upgrade

## Dependencies

**Requirements** (installed automatically if you use `pip`): requests, pyformance
**Requirements**
- `requests`, `pyformance` - installed automatically if you use `pip` to install apptuit
- `pandas` - not installed by default, you should install it manually if you intend to use the `query` API and
create dataframes using the `to_df()` method (see [Querying for Data](#querying-for-data))

## Usage

Expand Down Expand Up @@ -549,5 +552,7 @@ query_res = apptuit.query("fetch('proc.cpu.percent').downsample('1m', 'avg')", s
df = query_res[0].to_df()
# Another way of creating the DF is accessing by the metric name in the query
another_df = query_res['proc.cpu.percent'].to_df()

```
It should be noted that using the `to_df()` method requires that you have `pandas` installed.
We don't install `pandas` by default as part of the requirements because not every user of the library
would want to query or create dataframes (many users just use the `send` API or the reporter functionality)

0 comments on commit c5e3c2e

Please sign in to comment.