Skip to content

Commit e65f926

Browse files
authored
Merge pull request #27 from tusharrworkk-lab/readme-usage-clean
Add README usage guidance and examples links
2 parents de4bc70 + 6da6160 commit e65f926

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@ pip install percentify
4747

4848
Requires Python 3.10+, `numpy`, and `pandas` 2.0+.
4949

50+
## How to use percentify
51+
52+
Import the function that matches the question you want to answer, pass in a pandas or Polars object, and use the returned DataFrame or scalar directly in your notebook, report, or pipeline.
53+
54+
```python
55+
from percentify import missing, profiler
56+
57+
missing(df) # quick column-level check
58+
profiler(df, target="churn") # ranked data-quality issues and fixes
59+
```
60+
5061
## Quick example
5162

5263
```python
@@ -68,6 +79,11 @@ missing(df)
6879

6980
One import, one line. A clean, sorted DataFrame you can read or feed into the next step.
7081

82+
## Examples
83+
84+
- [Worked examples for every function](https://data-centt.github.io/percentify/documentation/)
85+
- [Project documentation](https://data-centt.github.io/percentify/)
86+
7187
## What's inside
7288

7389
| Function | What it answers |

0 commit comments

Comments
 (0)