sandyie-read 0.4.8

A lightweight Python library to read various data formats including PDF, images, YAML, and more.

Sandyie Read 📚

Effortlessly read files like PDFs, images, YAML, CSV, Excel, and more — powered by logging and custom exceptions.

---

⚠️ Python Compatibility

🐍 This library requires Python 3.7+.
⚠️ Some features may not work properly in versions below Python 3.11. Please use Python 3.11 or above for best compatibility.

---

🔧 Features

• ✅ Read and extract content from:
  • PDF (text-based and scanned with OCR)
  • Image files (JPG, PNG)
  • YAML files
  • Text files
  • CSV, Excel
• 🧠 OCR support using Tesseract
• 📋 Human-readable logging
• 🛡️ Clean exception handling (SandyieException)

---

📦 Installation

pip install sandyie_read

---

🚀 Quick Start

from sandyie_read import read

data = read("example.pdf")
print(data)

---

📁 Supported File Types & Examples

1. 📄 PDF (Text-based or Scanned)

data = read("sample.pdf")
print(data)

🟢 Returns: A string containing extracted text. OCR is auto-applied to scanned files.

---

2. 🖼️ Image Files (PNG, JPG)

data = read("photo.jpg")
print(data)

🟢 Returns: A string of OCR-extracted text.

---

3. ⚙️ YAML Files

data = read("config.yaml")
print(data)

🟢 Returns: A dictionary representing the YAML structure.

---

4. 📄 Text Files (.txt)

data = read("notes.txt")
print(data)

🟢 Returns: Plain text from file.

---

5. 📊 CSV Files

data = read("data.csv")
print(data)

🟢 Returns: pandas.DataFrame with structured data.

---

6. 📈 Excel Files (.xlsx, .xls)

data = read("report.xlsx")
print(data)

🟢 Returns: A DataFrame or dict of DataFrames for multi-sheet files.

---

⚠️ Error Handling

All exceptions are wrapped inside a custom SandyieException, making debugging simple and consistent.

---

🧪 Logging

Logs show:

• File type detection
• Success/failure for reads
• Detailed processing insights

---

📚 Auto-Generated Docs

Coming soon at 👉 https://sandyie.in/docs

It will include:

• 📘 API Reference
• ❌ Exception explanations
• 📓 Usage examples and notebooks

---

🤝 Contribute

Spotted a bug or have a new idea?
Open an Issue or send a Pull Request.

---

📄 License

Licensed under the MIT License.
See LICENSE for more.

---

👤 Author

Sanju (aka Sandyie)
🌐 Website: www.sandyie.in
📧 Email: [e-mail]
🐍 PyPI: https://pypi.org/project/sandyie-read

---