Install & Compatibility
Where this runs
tested against v5.2.2 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
build_error
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 7.1s · import 0.000s · 427MB
423MB installed
● package 423MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
frame_from_hyper
✓ from pantab import frame_from_hyper
✗ from pantab import to_hyper
frame_to_hyper
✓ from pantab import frame_to_hyper
✗ from pantab import to_hyper
frames_from_hyper
✓ from pantab import frames_from_hyper
✗ from pantab import to_hyper
This quickstart demonstrates how to create a pandas DataFrame, write it to a Tableau Hyper file using `pantab.to_hyper`, and then read it back into a DataFrame using `pantab.frame_from_hyper`. It includes cleanup to remove the generated Hyper file.
import pandas as pd
import pantab as pt
import os
data = {
'col1': [1, 2, 3],
'col2': ['A', 'B', 'C'],
'col3': [True, False, True]
}
df = pd.DataFrame(data)
hyper_file = 'my_data.hyper'
table_name = 'MyTable'
try:
# Write DataFrame to Hyper file
pt.to_hyper(df, hyper_file, table=table_name)
print(f"DataFrame written to {hyper_file} successfully.")
# Read DataFrame from Hyper file
read_df = pt.frame_from_hyper(hyper_file, table=table_name)
print(f"DataFrame read from {hyper_file} successfully:")
print(read_df)
finally:
# Clean up the generated file
if os.path.exists(hyper_file):
os.remove(hyper_file)
print(f"Cleaned up {hyper_file}.")
Debug
Known issues
breakingPantab v5.3.0 dropped support for Python 3.9 and 3.10. Users on these Python versions will need to upgrade to Python 3.11 or later to use the latest Pantab.fixUpgrade your Python environment to 3.11 or newer, or pin your pantab version to <5.3.0.
affects: >=5.3.0
breakingPantab relies on `tableauhyperapi`, which periodically updates its minimum required version. Older `tableauhyperapi` versions can lead to `RuntimeError` or `ValueError`.fixEnsure `tableauhyperapi` is updated to at least the minimum version required by your `pantab` installation. Running `pip install --upgrade pantab` usually resolves this by updating its dependencies.
affects: All versions, specifically 4.1.0+ and 5.0.0+
gotchaData type mapping between pandas and Hyper can have nuances. For instance, 8-bit integer columns in pandas will be stored as 16-bit integers in Hyper. Other types might also undergo conversions.fixReview `pantab` documentation for specific data type mappings to ensure your data integrity and expected column types in Tableau. Test conversions with representative datasets.
affects: All versions
gotchaHyper files are single-writer, single-reader. Concurrent access or insufficient file permissions can lead to errors, especially on network drives or shared environments.fixEnsure the process writing or reading the Hyper file has appropriate file system permissions. Avoid concurrent writes to the same Hyper file. Close file handlers properly if managing them manually (though `pantab` generally handles this).
affects: All versions
Upgrade
Version history
5.3.0latest on PyPI · released Apr 8, 2026
Audit
Dependencies
pandasrequiredCore data structure for conversion.
tableauhyperapirequiredUnderlying library for interacting with Tableau Hyper files.