slowpoke-flask 0.1.0

Track slow Flask routes and monitor bottlenecks

# 🐢 Slowpoke

Slowpoke is a lightweight Python package that helps you monitor and log slow API routes in your Flask application. If you're wondering "Which endpoints are dragging me down?", Slowpoke has your back.

---

🚀 Installation

Until we publish on PyPI, install directly from GitHub:

pip install git+https://github.com/vedangit/slowpoke.git

---

⚙️ Usage

1. Add slowpoke to your Flask app

from flask import Flask
from slowpoke import SlowpokeLogger

app = Flask(__name__)
slowpoke_logger = SlowpokeLogger(app, threshold_ms=1000)

The threshold_ms parameter sets the time (in milliseconds) after which a request is considered slow.

---

2. Run your app normally

Make requests as usual. Slowpoke will track how long each endpoint takes.

---

3. View the report

Once you've made some requests, generate a report from the command line:

slowpoke report

This will print a table of all routes that exceeded the threshold, including method, endpoint, duration, and timestamp.

---

🧪 Example App

You can test out slowpoke quickly by running the example Flask app:

cd examples
python app.py

Then hit some routes and run:

slowpoke report

---

🛣️ Roadmap

✅ Version 0 (Current):

• Log all Flask routes that exceed a threshold.
• CLI tool to view slow route report.

🔜 Version 1 (Coming soon):

• Middleware-based integration.
• Save reports to file.
• Optional integration with logging tools.
• FastAPI + Django support.

---

🧠 Why Slowpoke?

• 🚀 Fast to integrate
• 🔍 Focused on performance bottlenecks
• 🧼 Clean CLI reporting
• 💻 Perfect for side projects or production

---

👩‍💻 Author

Made with ❤️ by Vedangi

---

📄 License

MIT License