docs: Enhance README with comprehensive documentation and sample listings #42
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…samples - Add table of contents for better navigation - Include all sample applications (Django-Mongo, Flask-PostgreSQL, Sanic-Mongo, Sanic-Postgres) - Add prerequisites section and getting started guide - Include framework and database coverage information - Improve contribution guidelines - Restructure content for better readability Signed-off-by: AryanV-Coder <aryanv.india1@gmail.com>
153fdb4 to
e96bb1c
Compare
There was a problem hiding this comment.
Hey @AryanV-Coder, Thank you for raising the pr. Our team will review it soon
| - [Prerequisites](#prerequisites) | ||
| - [Sample Applications](#python-sample-apps-with-keploy) | ||
| - [Getting Started](#getting-started) | ||
| - [Running the Samples](#running-the-samples) |
There was a problem hiding this comment.
Hey @AryanV-Coder, We don't need this section, You can delete it
|
|
||
| This repository contains sample applications demonstrating [Keploy's](https://keploy.io) integration with various Python-based web frameworks and databases. Keploy is an API testing platform that automatically generates test cases and data mocks from API calls, making testing more efficient and comprehensive. | ||
|
|
||
| These samples showcase how to integrate Keploy with different Python web frameworks and databases, providing practical examples for your own projects. Each sample includes detailed setup instructions and demonstrates key Keploy features like test generation, data mocking, and test execution. |
| ## Python Sample Apps with Keploy | ||
|
|
||
| 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. | ||
| 1. [Flask-Mongo](https://github.com/keploy/samples-python/tree/main/flask-mongo) - A simple task management API built using Flask and MongoDB for data storage. It demonstrates CRUD operations on student records with CORS support. |
There was a problem hiding this comment.
Remove the unwanted lines and there was no need to update the flask mongo portion
|
|
||
| 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. | ||
| Please ensure your sample application includes: | ||
| - Clear setup and usage instructions |
| For detailed instructions, refer to the README.md file in each sample application directory. | ||
|
|
||
| ## Framework and Database Coverage | ||
|
|
There was a problem hiding this comment.
Remove this portion also as we do not need it
|
|
||
| 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. | ||
| 1. Fork the repository |
pratik-mahalle
suggested changes
Aug 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhanced README Documentation
Overview
This PR significantly improves the samples-python repository documentation by providing a more comprehensive and well-structured README.md file. The enhanced documentation aims to make it easier for new users to understand the purpose of the repository, the available sample applications, and how to get started with Keploy.
Changes
Why This Matters
Better documentation lowers the barrier to entry for new users and contributors. With this improved README, users can:
Testing Done
Verified all links work correctly and the information provided is accurate according to the current repository structure.