Metadata-Version: 2.3
Name: showstats
Version: 0.0.2
Summary: Vertical summary statistics for data frames
Project-URL: Homepage, https://github.com/matthiaskaeding/showstats
Project-URL: Issues, https://github.com/matthiaskaeding/showstats/issues
Project-URL: Changelog, https://github.com/matthiaskaeding/showstats/blob/main/changelog.md
Author: Matthias Kaeding
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: polars>=0.20.21
Provides-Extra: pandas
Requires-Dist: pandas>=1.5.3; extra == 'pandas'
Requires-Dist: pyarrow>=10.0.0; extra == 'pandas'
Description-Content-Type: text/markdown

# showstats: quick and compact summary statistics


**showstats** produces summary statistic tables with vertical
orientation.

``` python
from showstats import show_stats

show_stats(df)
```

    | Var.          | Null % | Mean          | Median        | Std.     | Min           | Max          |
    | N=1.00E+6     |        |               |               |          |               |              |
    |---------------|--------|---------------|---------------|----------|---------------|--------------|
    | float_mean_2  | 0%     | 2.0           | 2.0           | 1.0      | -2.6          | 6.6          |
    | float_std_2   | 0%     | 0.0013        | 0.00024       | 2.0      | -9.3          | 9.3          |
    | float_min_7   | 0%     | 12.0          | 12.0          | 1.0      | 7.0           | 16.0         |
    | float_max_17  | 0%     | 12.0          | 12.0          | 1.0      | 7.7           | 17.0         |
    | bool_col      | <40%   | 0.5           | 0.0           | 0.5      | 0.0           | 1.0          |
    | int_col       | 0%     | 500000.0      | 500000.0      | 290000.0 | 0.0           | 1000000.0    |
    | float_col     | 0%     | 5000.0        | 5000.0        | 2900.0   | 0.0           | 10000.0      |
    | U             | 0%     | 0.5           | 0.5           | 0.29     | 5.1e-7        | 1.0          |
    | int_with_miss | <20%   | 500000.0      | 500000.0      | 290000.0 | 1.0           | 1000000.0    |
    | ings          |        |               |               |          |               |              |
    | datetime_col  | 0%     | 1750-01-30    | 1750-03-18    |          | 1500-01-01    | 1999-12-31   |
    |               |        | 01:54:50      | 04:52:16      |          | 04:17:28      | 21:39:20     |
    | datetime_col_ | 0%     | 1750-01-12    | 1750-01-22    |          | 1500-01-01    | 1999-12-31   |
    | 2             |        | 23:02:09      | 06:33:24      |          | 06:19:48      | 17:41:57     |
    | date_col      | 0%     |               |               |          | 1500-01-01    | 1999-12-31   |
    | date_col_2    | 0%     |               |               |          | 1500-01-01    | 1999-12-31   |
    | str_col       | <60%   |               |               |          | ABC           | foo          |
    | enum_col      | 0%     |               |               |          | worst         | best         |
    | categorical_c | 0%     |               |               |          | Fara          | Car          |
    | ol            |        |               |               |          |               |              |
    | null_col      | 100%   |               |               |          |               |              |

Primarily built for polars data frames, **showstats** converts other
inputs. For full compatibility with pandas.DataFrames install as
`pip install showstats[pandas]`.

Because **showstats** uses polars as backend, its really fast: \<1
second for a 1,000,000 × 1,000 data frame, running on a M1 MacBook.
