Metadata-Version: 2.4
Name: stringcleaner
Version: 0.1.1
Summary: A lightweight Python utility to clean special characters from text inputs with built-in input validation and error handling.
Home-page: https://github.com/ANDROID564/stringcleaner
Author: ANDROID564
Author-email: ANDROID564 <tanveermustafa94@gmail.com>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# stringcleaner

A lightweight Python utility to clean special characters from text inputs — with built-in input validation and error handling.

---

## 🚀 Features

- ✅ Removes all special characters, keeping only letters, numbers, and whitespace  
- ✅ Validates input to ensure it's a non-empty string  
- ✅ Graceful error handling using decorators  
- ✅ Minimal and production-friendly codebase  

---

## 🧪 Example

```python
from stringcleaner import clean_text

result, error = clean_text("Hello! @2025 ✨ World??")
if error:
    print("Error:", error)
else:
    print("Cleaned:", result)
```

**Output:**
```
Cleaned: Hello 2025  World
```

---

## 🛠 Installation

This package is not yet published to PyPI. To install locally:

```bash
git clone https://github.com/ANDROID564/stringcleaner
cd stringcleaner
pip install .
```

---

## 📜 License

This software is distributed under the  
**📄 stringcleaner – Custom Non-Commercial Software License**  
See [`LICENSE`](./LICENSE) for full terms.

---

## 🤝 Contributing

This repository is currently closed for commercial contributions.  
Feel free to fork and use for personal, research, or academic purposes.

---

## 📫 Contact

For commercial use or collaboration inquiries, reach out to:  
**📧 [tanveermustafa94@gmail.com](mailto:tanveermustafa94@gmail.com)**

