Metadata-Version: 2.1
Name: rich-dataframe
Version: 0.1.6
Summary: Create animated and pretty Pandas Dataframe
Home-page: https://github.com/khuyentran1401/rich-dataframe
License: Apache-2.0
Keywords: pandas
Author: khuyentran1401
Author-email: khuyentran1476@gmail.com
Requires-Python: ==3.7.8
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Dist: pandas (>=1.2.2,<2.0.0)
Requires-Dist: rich (>=9.10.0,<10.0.0)
Requires-Dist: sklearn (>=0.0,<0.1)
Project-URL: Repository, https://github.com/khuyentran1401/rich-dataframe
Description-Content-Type: text/markdown

# Rich DataFrame

Create animated and pretty Pandas Dataframe, as shown below:

![image](https://github.com/khuyentran1401/rich-dataframe/blob/master/prettify_table.gif?raw=True)

# Installation
```bash
pip install rich-dataframe
```
# Usage
## Minimal example
```python
from sklearn.datasets import fetch_openml
from rich_dataframe import DataFramePrettify

if __name__=='__main__':
    speed_dating = fetch_openml(name='SpeedDating', version=1)['frame']
    
    table = DataFramePrettify(speed_dating, row_limit=20, first_rows=True, delay_time=5).prettify()
    
```
## Parameters
* **df: pd.DataFrame**
The data you want to prettify
* **row_limit : int, optional**
    Number of rows to show, by default `20`
* **col_limit : int, optional**
    Number of columns to show, by default `10`
* **first_rows : bool, optional**
    Whether to show first n rows or last n rows, by default `True`. If this is set to False, show last n rows.
* **first_cols : bool, optional**
    Whether to show first n columns or last n columns, by default True. If this is set to `False`, show last n rows.
* **delay_time : int, optional**
    How fast is the animation, by default `5`. Increase this to have slower animation.


