From ff4267a5e5c5378e1eaacae7bee1bee8d9be7804 Mon Sep 17 00:00:00 2001
From: Nikhil Dwivedi <98373905+devilsrage@users.noreply.github.com>
Date: Thu, 19 Jun 2025 09:30:38 +0530
Subject: [PATCH] Update README.md
---
README.md | 95 +++++++++++++++++++++++++++++++++++++++++--------------
1 file changed, 71 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
index f14f414..d31c0da 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,88 @@
-
Keploy Python Sample Applications
+๐ Keploy Python Sample Applications
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A collection of Python sample applications integrated with Keploy for API testing, mocking, and observability.
+
-
-
+---
-
-
+## ๐ About This Repository
-
-
-
+This repository hosts sample Python applications that demonstrate how to integrate **Keploy** into various Python frameworks and databases. These examples are designed to help developers learn how to capture API calls, auto-generate test cases, and mock dependencies for faster, more reliable testing.
+
+๐ก **Looking to contribute?** We welcome new sample applications and improvements to existing ones!
+
+> โ ๏ธ **Note:** Issue creation is disabled on this repository. Please submit issues via the main [Keploy issue tracker](https://github.com/keploy/keploy/issues/new/choose).
+
+---
+
+## ๐ Python Sample Applications with Keploy
+
+| Application | Tech Stack | Description |
+|-------------|------------|-------------|
+| [Flask-Mongo](https://github.com/keploy/samples-python/tree/main/flask-mongo) | Flask + MongoDB | Task management API with CRUD operations on student records. Supports CORS for cross-origin requests. |
+| [Django-Postgres](https://github.com/keploy/samples-python/tree/main/django-postgres) | Django + PostgreSQL | User management API supporting CRUD operations on user records. |
+| [FastAPI-Postgres](https://github.com/keploy/samples-python/tree/main/fastapi-postgres) | FastAPI + PostgreSQL | Student management API with CRUD operations on student data. |
+| [FastAPI-Twilio](https://github.com/keploy/samples-python/tree/main/fastapi-twilio) | FastAPI + Twilio | SMS-sending API using Twilioโs messaging service. |
+| [Flask-Redis](https://github.com/keploy/samples-python/tree/main/flask-redis) | Flask + Redis | Book management API with caching and storage using Redis. Supports CRUD and optimized search. |
+
+---
+
+## ๐ฌ Community Support
+
+Need help, have questions, or want to connect with other developers?
+
+๐ **Join our Slack community:** [Keploy Slack](https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg)
+
+Weโre happy to help you get started or discuss your ideas!
+
+---
+
+## ๐ค Contributing
+
+We โค๏ธ contributions! Hereโs how you can help:
+
+- โจ Add new sample applications or integrations
+- ๐ Improve existing examples
+- ๐ Report issues on [Keploy main repo](https://github.com/keploy/keploy/issues/new/choose)
+
+Please make sure to read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
-This repo contains the samples for [Keploy's](https://keploy.io) integration with Python-based Application. Please feel free to contribute if you'd like submit a sample for another use-case or library.
+---
-> **Note** :- Issue Creation is disabled on this Repository, please visit [here](https://github.com/keploy/keploy/issues/new/choose) to submit Issue.
+## โก Getting Started
-## Python Sample Apps with Keploy
+Each sample application comes with its own README explaining:
-1. [Flask-Mongo](https://github.com/keploy/samples-python/tree/main/flask-mongo) - This application is a simple task management API built using Python's Flask framework and MongoDB for data storage. It allows you to perform basic CRUD (Create, Read, Update, Delete) operations on student records. The API supports CORS (Cross-Origin Resource Sharing) to facilitate cross-domain requests.
+- ๐น How to set it up
+- ๐น How to run it with Keploy
+- ๐น How to generate tests
-2. [Django-Postgres](https://github.com/keploy/samples-python/tree/main/django-postgres) - This is an application to perform basic CRUD (Create, Read, Update, Delete) operations on user records built using Python's Django framework and PostgreSQL for data storage.
+๐ Check inside each applicationโs folder for detailed instructions.
-3. [FastAPI-Postgres](https://github.com/keploy/samples-python/tree/main/fastapi-postgres) - This application is a student management API built using Python's FastAPI and PostgreSQL for data storage. It allows you to perform basic CRUD (Create, Read, Update, Delete) operations on student data.
+---
-4. [FastAPI-Twilio](https://github.com/keploy/samples-python/tree/main/fastapi-twilio) - This application is a SMS sending API built using Python's FastAPI and Twilio for their SMS sharing service.
+## ๐ License
-5. [Flask-Redis](https://github.com/keploy/samples-python/tree/main/flask-redis) - This Flask-based application provides a book management system utilizing Redis for caching and storage. It supports adding, retrieving, updating, and deleting book records, with optimized search functionality and cache management for improved performance. The API endpoints ensure efficient data handling and quick access to book information.
+This repository is licensed under the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).
-## Community Support โค๏ธ
+---
-### ๐ค Questions?
+## ๐ About Keploy
-Reach out to us. We're here to help!
+[Keploy](https://keploy.io) is an open-source tool that generates test cases and data mocks by recording real API traffic โ helping you test faster with high coverage and no manual effort.
-[](https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg)
-[](https://www.linkedin.com/company/keploy/)
-[](https://www.youtube.com/channel/UC6OTg7F4o0WkmNtSoob34lg)
-[](https://twitter.com/Keployio)
+---
-### ๐ Let's Build Together!