🐾 Ka-Doe

Ka-Doe is a document processing and previewing service powered by FastAPI, OCR, and feline-grade modularity. It helps you extract, form, and chunk documents — gracefully and efficiently.

“A soft-pawed tabby whose whispers tamed tempests, and whose radiant eyes kindled love amid flames.”

---

✨ Features

• 📄 Document Parsing – Extracts content from PDFs and images
• 🧠 Preview Chunking – Breaks content into bite-sized, previewable pieces
• ⚙️ Customizable API – Modular endpoints using FastAPI
• 🐱 PurrfectKit Integration – Built-in utilities for smarter processing

---

🚀 Quick Start

1. Requirements

• Python 3.12.4
• Tesseract OCR
• Poppler
• ffmpeg, libmagic1
• Git

2. Install Dependencies

sudo apt-get update
sudo apt-get install tesseract-ocr tesseract-ocr-tha poppler-utils ffmpeg libmagic1
pip install fastapi uvicorn python-multipart \
  git+https://github.com/suwalutions/PurrfectKit.git@meow

3. Run the Server

uvicorn main:app

Visit http://127.0.0.1:8080/docs to explore the API using Swagger UI.

🧭 Project Structure

.
├── api/                  # Core logic and routes
│   └── routes/v1/        # Versioned API endpoints
├── docs/                 # MkDocs documentation
├── dockers/              # Docker & Compose setup
├── main.py               # Application entrypoint
├── requirements.txt      # Python dependencies
├── mkdocs.yml            # Documentation site config

📚 Documentation

Full documentation is available via MkDocs:

pip install mkdocs mkdocs-material mkdocstrings[python]
mkdocs serve -a localhost:8001

Then visit: http://127.0.0.1:8001

🛠 Contributing

Contributions are welcome! To contribute:

1. Fork this repo
2. Create a new branch: git checkout -b feature-name
3. Commit changes: git commit -am 'Add feature'
4. Push: git push origin feature-name
5. Open a pull request 🐾

📄 License

MIT License. See LICENSE for more info.

❤️ Acknowledgements

Built with care, curiosity, and cat-like precision. Powered by Python, driven by passion.