Metadata-Version: 2.1
Name: pantab
Version: 0.0.1.dev2
Summary: Converts pandas DataFrames into Tableau Hyper Extracts
Home-page: https://github.com/WillAyd/pantab
Author: Will Ayd
Author-email: william.ayd@icloud.com
License: MIT
Keywords: tableau visualization pandas dataframe
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Office/Business
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pandas
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'

# pantab: Connecting pandas with Tableau

## What is it?

**pantab** is a tool to help generate Hyper extracts (available with Tableau 10.5+) from a pandas DataFrame.


```python
import pandas as pd
import pantab

df = pd.DataFrame(
    [[1, 2, 3, 4., 5., True, pd.to_datetime('1/1/18'), 'foo'],
     [6, 7, 8, 9., 10., True, pd.to_datetime('1/1/19'), 'foo']
     ], columns=['foo', 'bar', 'baz', 'qux', 'quux', 'quuuz', 'corge',
                 'garply'])

pantab.frame_to_hyper(df, "foo.hyper", "the_table")
```

The above will generate a Hyper extract in the specified location, which you can then open in Tableau.

![Hyper Extract in Tableau](samples/demo.png)

## Requirements & Installation

* Python >= 3.6
* Tableau Hyper API (see installation instructions [here](https://help.tableau.com/current/api/hyper_api/en-us/docs/hyper_api_installing.html#install-the-hyper-api-for-python-36-and-37))
* [pandas](https://pandas.pydata.org)

The preferred way to install this package is from pip. Note that this will resolve the pandas dependency for you but **will not resolve the Tableau Hyper API** dependency. Please refer to their installation instructions.

```sh
pip install pantab
```

If you want to run the test suite for this application, you will also need to install [pytest](https://pytest.org).

## Contributing

Want to make this package better? Awesome - any and all contributions are appreciated! With that said, any code contributions **must** contain test cases to be considered for merging.


