Tableau Hyper IO: read and write Tableau hyper files using Pandas DataFrames

What is it?

A simple way to read Tableau hyper files into Pandas DataFrames and write to Tableau hyper files from Pandas DataFrames.

Why was this made?

For a project I was working on I needed to read hyper files. I searched if a package already existed and found only the pandleau package, which only writes to hyper files but does not read them and also uses the older extract 2.0 API. Since I couldn't find any other package that met my needs I decided to make one myself, which has been a good learning experience.

Installation

You can install tableauhyperio using pip:

pip install tableauhyperio

This will also try downloading the Tableau hyper API, tqdm and pandas packages if you don't have them already.

Example usage

import tableauhyperio as hio

# Reading a regular hyper file
df = hio.read_hyper("example.hyper")

# Reading a hyper file with a custom schema
df = hio.read_hyper("example.hyper", "my_schema")

# Writing a regular hyper file
hio.to_hyper(df, "example_output.hyper")

# Writing a hyper file with a custom schema and custom table name
hio.to_hyper(df, "example_output.hyper", "my_schema", "my_table")