# Tidy Viewer Py
## Installation
```bash
pip install tidy-viewer-py
```
## Quick Start
### CSV File Pretty Printing
```python
import tidy_viewer_py as tv
import pandas as pd
url = "https://raw.githubusercontent.com/mwaskom/seaborn-data/master/iris.csv"
pd.read_csv(url).to_csv("iris.csv", index=False) # Save to csv for demo
filename = "iris.csv"
tv.print_csv(filename)
```
### Pandas DataFrames Pretty Printing
```python
import pandas as pd
import tidy_viewer_py as tv
df = pd.read_csv(filename)
tv.print_dataframe(df)
```
### Polars DataFrames Pretty Printing
```python
import polars as pl
df_pl = pl.read_csv(filename)
tv.print_polars_dataframe(df_pl)
```
### Method Chaining API
```python
import tidy_viewer_py as tv
tv.tv().color_theme("gruvbox").max_rows(10).print_dataframe(df)
```
## Configuration Options
```python
options = tv.FormatOptions(
# Display options
max_rows=25, # Maximum rows to display (None for all)
max_col_width=20, # Maximum column width
min_col_width=2, # Minimum column width
# Styling
use_color=True, # Enable/disable colored output
color_theme="nord", # Color theme
# Data formatting
delimiter=",", # CSV delimiter
significant_figures=3, # Number of significant figures
preserve_scientific=False,# Preserve scientific notation
max_decimal_width=13, # Max width before scientific notation
# Table elements
no_dimensions=False, # Hide table dimensions
no_row_numbering=False, # Hide row numbers
title="My Table", # Table title
footer="End of data", # Table footer
)
```
## Color Themes
Available themes:
- `nord` (default) - Arctic, north-bluish color palette
- `gruvbox` - Retro groove color scheme
- `dracula` - Dark theme with vibrant colors
- `one_dark` - Atom One Dark inspired
- `solarized_light` - Precision colors for readability
### Building from Source
Requirements:
- Python 3.8+
- Rust 1.70+
- uv (recommended) or pip
```bash
git clone https://github.com/yourusername/tidy-viewer-py
cd tidy-viewer-py
uv pip install .
```
Raw data
{
"_id": null,
"home_page": null,
"name": "tidy-viewer-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "table, formatting, terminal, pretty-print, csv, parquet",
"author": null,
"author_email": "Alex Hallam <alexhallam6.28@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e9/24/be6295f4ffd139cc4873ecfafe91007c8c079da707003f80fd68c52c9cc4/tidy_viewer_py-0.2.94.tar.gz",
"platform": null,
"description": "# Tidy Viewer Py\r\n\r\n## Installation\r\n\r\n```bash\r\npip install tidy-viewer-py\r\n```\r\n\r\n## Quick Start\r\n\r\n### CSV File Pretty Printing\r\n\r\n```python\r\nimport tidy_viewer_py as tv\r\nimport pandas as pd\r\nurl = \"https://raw.githubusercontent.com/mwaskom/seaborn-data/master/iris.csv\"\r\npd.read_csv(url).to_csv(\"iris.csv\", index=False) # Save to csv for demo\r\nfilename = \"iris.csv\"\r\ntv.print_csv(filename)\r\n```\r\n\r\n### Pandas DataFrames Pretty Printing\r\n\r\n```python\r\nimport pandas as pd\r\nimport tidy_viewer_py as tv\r\ndf = pd.read_csv(filename)\r\ntv.print_dataframe(df)\r\n```\r\n\r\n### Polars DataFrames Pretty Printing\r\n\r\n```python\r\n\r\nimport polars as pl\r\n\r\ndf_pl = pl.read_csv(filename)\r\ntv.print_polars_dataframe(df_pl)\r\n```\r\n\r\n### Method Chaining API\r\n\r\n```python\r\nimport tidy_viewer_py as tv\r\n\r\ntv.tv().color_theme(\"gruvbox\").max_rows(10).print_dataframe(df)\r\n```\r\n\r\n## Configuration Options\r\n\r\n```python\r\noptions = tv.FormatOptions(\r\n # Display options\r\n max_rows=25, # Maximum rows to display (None for all)\r\n max_col_width=20, # Maximum column width\r\n min_col_width=2, # Minimum column width\r\n \r\n # Styling\r\n use_color=True, # Enable/disable colored output\r\n color_theme=\"nord\", # Color theme\r\n \r\n # Data formatting\r\n delimiter=\",\", # CSV delimiter\r\n significant_figures=3, # Number of significant figures\r\n preserve_scientific=False,# Preserve scientific notation\r\n max_decimal_width=13, # Max width before scientific notation\r\n \r\n # Table elements\r\n no_dimensions=False, # Hide table dimensions\r\n no_row_numbering=False, # Hide row numbers\r\n title=\"My Table\", # Table title\r\n footer=\"End of data\", # Table footer\r\n)\r\n```\r\n\r\n## Color Themes\r\n\r\nAvailable themes:\r\n- `nord` (default) - Arctic, north-bluish color palette\r\n- `gruvbox` - Retro groove color scheme\r\n- `dracula` - Dark theme with vibrant colors\r\n- `one_dark` - Atom One Dark inspired\r\n- `solarized_light` - Precision colors for readability\r\n\r\n\r\n### Building from Source\r\n\r\nRequirements:\r\n- Python 3.8+\r\n- Rust 1.70+\r\n- uv (recommended) or pip\r\n\r\n```bash\r\ngit clone https://github.com/yourusername/tidy-viewer-py\r\ncd tidy-viewer-py\r\nuv pip install .\r\n```\r\n\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "A cross-platform data pretty printer that uses column styling to maximize viewer enjoyment. Supports CSV, Parquet, Pandas, and Polars DataFrames.",
"version": "0.2.94",
"project_urls": {
"Homepage": "https://github.com/yourusername/tidy-viewer-py",
"Issues": "https://github.com/yourusername/tidy-viewer-py/issues",
"Repository": "https://github.com/yourusername/tidy-viewer-py"
},
"split_keywords": [
"table",
" formatting",
" terminal",
" pretty-print",
" csv",
" parquet"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "454b5fe2168e2284efa7ddbd80916e646d03e87448cba99f239d53cd5e61d9e6",
"md5": "dff958c70c4481b39f321ce4a761cd58",
"sha256": "1c0f88d565fe91aaf95348a9dd6b9e2db4d24dbe3ccd763be4427cde16c321a0"
},
"downloads": -1,
"filename": "tidy_viewer_py-0.2.94-cp313-cp313-win_amd64.whl",
"has_sig": false,
"md5_digest": "dff958c70c4481b39f321ce4a761cd58",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.8",
"size": 2241752,
"upload_time": "2025-08-11T17:16:19",
"upload_time_iso_8601": "2025-08-11T17:16:19.096858Z",
"url": "https://files.pythonhosted.org/packages/45/4b/5fe2168e2284efa7ddbd80916e646d03e87448cba99f239d53cd5e61d9e6/tidy_viewer_py-0.2.94-cp313-cp313-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e924be6295f4ffd139cc4873ecfafe91007c8c079da707003f80fd68c52c9cc4",
"md5": "d067d5f3d2d4ac08787606cd0e94e63d",
"sha256": "3b0867e660ff7199aecfd11031a88f385f3ed54339b97aed079e98ff6b289ebf"
},
"downloads": -1,
"filename": "tidy_viewer_py-0.2.94.tar.gz",
"has_sig": false,
"md5_digest": "d067d5f3d2d4ac08787606cd0e94e63d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 109996,
"upload_time": "2025-08-11T17:16:20",
"upload_time_iso_8601": "2025-08-11T17:16:20.696349Z",
"url": "https://files.pythonhosted.org/packages/e9/24/be6295f4ffd139cc4873ecfafe91007c8c079da707003f80fd68c52c9cc4/tidy_viewer_py-0.2.94.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 17:16:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "tidy-viewer-py",
"github_not_found": true,
"lcname": "tidy-viewer-py"
}
JSON
