Skip to content

Commit 7031eec

Browse files
authored
Revise README for clarity on Percentify's purpose
Updated the README to clarify the purpose and usage of Percentify, emphasizing its focus on simplifying data science operations with clear function calls.
1 parent 85d782d commit 7031eec

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Percentify
1+
2+
<h1 align="center">
3+
<img src="assets/favicon.png" alt="Percentify logo" height="40">
4+
&nbsp;Percentify
5+
</h1>
26

37
[![Downloads](https://static.pepy.tech/badge/percentify)](https://pepy.tech/project/percentify)
48
[![PyPI version](https://img.shields.io/pypi/v/percentify.svg?style=flat&color=blue)](https://pypi.org/project/percentify/)
@@ -7,9 +11,10 @@
711
[![Docs](https://img.shields.io/badge/docs-percentify-14b8a6)](https://data-centt.github.io/percentify/)
812
[![Build Status](https://github.com/data-centt/percentify/actions/workflows/python-app.yml/badge.svg)](https://github.com/data-centt/percentify/actions/workflows/python-app.yml)
913

10-
**Percentify is a niche data science library for practitioners and learners alike, drawing its main dependencies from pandas and numpy, and including everyday statistics.**
14+
**Percentify is a data science library that turns the 20% of data science operations behind 80% of daily work into single, readable function calls.**
15+
1116

12-
Following the **Pareto principle**, Percentify brings the 20% of operations that make up 80% of daily data work to the forefront, each as a single, readable function call. It not built to compete with pandas, scipy, statsmodels, or scikit-learn; it stands on their shoulders and works alongside them, naming the library each function draws from so you always know where to dig deeper.
17+
Built on pandas and numpy, it pairs everyday hard to reach tools with lesser-known ones. Where a function wraps an existing library (pandas, scipy, statsmodels, scikit-learn), it names it, so you always know where to dig deeper.
1318

1419
## 📖 Documentation
1520

@@ -63,22 +68,21 @@ One import, one line. A clean, sorted DataFrame you can read or feed into the ne
6368

6469
## 🛟 Friendly by design
6570

66-
- **No cryptic tracebacks.** Hand a function a text column where numbers are needed and you get a clear `PercentifyWarning`, not an Arrow/NumPy stack trace.
67-
- **Sensible defaults.** Results come back sorted worst-first, and PCA is standardized out of the box.
68-
- **DataFrames everywhere**, so the output drops straight into your notebook, your next filter, or your model.
71+
- **No cryptic tracebacks**; Hand a function a text column where numbers are needed and you get a clear PercentifyWarning, not an Arrow/NumPy stack trace.
72+
- **Sensible defaults**; Results come back sorted worst-first, and PCA is standardized out of the box.
73+
- **DataFrames everywhere**; so the output drops straight into your notebook, your next filter, or your model.
74+
6975

7076
## 🤝 Contributing
7177

7278
Contributions are welcome but they must follow the repo's guiding principle:
73-
74-
> **Keep each method as direct-to-output as possible.** A percentify function should return the single most common answer in one line, and point users to the underlying library (pandas, scipy, statsmodels, scikit-learn) for the full, configurable version when the simplest output isn't what they're after.
79+
> Keep each method as direct-to-output as possible. A percentify function should return the single most common answer in one line, and point users to the underlying library (pandas, scipy, statsmodels, scikit-learn) for the full, configurable version when the simplest output isn't what they're after.
7580
7681
If your idea keeps things that simple and direct:
77-
7882
- Open an issue first to discuss it
7983
- Fork the repo
8084
- Create a branch
8185
- Commit your changes
8286
- Open a pull request
8387

84-
Anything that adds knobs and options for their own sake, or duplicates what the parent libraries already do well, is out of scope, those cases should point to the source library instead.
88+
> Anything that adds knobs and options for their own sake, or duplicates what the parent libraries already do well, is out of scope; those cases should point to the source library instead.

0 commit comments

Comments
 (0)