Skip to content

Add README usage guidance and examples links #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Daniel15568 merged 1 commit into from
Jul 17, 2026
Merged

Add README usage guidance and examples links #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@ pip install percentify

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

## How to use percentify

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.

```python
from percentify import missing, profiler

missing(df) # quick column-level check
profiler(df, target="churn") # ranked data-quality issues and fixes
```

## Quick example

```python
Expand All @@ -69,6 +80,11 @@ missing(df)

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

## Examples

- [Worked examples for every function](https://data-centt.github.io/percentify/documentation/)

@Daniel15568 Daniel15568 Jul 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would need extra use examples outside the docs. I'll merge this and rewrite issue.

@tusharrworkk-lab tusharrworkk-lab Jul 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright. I will put in more examples then

@tusharrworkk-lab tusharrworkk-lab Jul 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. if you feel like anything more could be added. I will be happy to make one more pr for the same

- [Project documentation](https://data-centt.github.io/percentify/)

## What's inside

| Function | What it answers |
Expand Down
Loading