-
Notifications
You must be signed in to change notification settings - Fork 55
Enhance README: clearer structure, contribution info, and app overview table #59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
devilsrage
wants to merge
1
commit into
keploy:main
Choose a base branch
from
devilsrage:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,88 @@ | ||
| <h1 align="center"> Keploy Python Sample Applications </h1> | ||
| <h1 align="center">🚀 Keploy Python Sample Applications</h1> | ||
|
|
||
| <p align="center"> | ||
| <a href="CODE_OF_CONDUCT.md" alt="Contributions Welcome"> | ||
| <img src="https://img.shields.io/badge/Contributions-Welcome-brightgreen?logo=github" /> | ||
| </a> | ||
| <a href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg" alt="Slack Community"> | ||
| <img src=".github/slack.svg" /> | ||
| </a> | ||
| <a href="https://opensource.org/licenses/Apache-2.0" alt="License: Apache 2.0"> | ||
| <img src=".github/License-Apache_2.0-blue.svg" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <em>A collection of Python sample applications integrated with <a href="https://keploy.io">Keploy</a> for API testing, mocking, and observability.</em> | ||
| </p> | ||
|
|
||
| <a href="CODE_OF_CONDUCT.md" alt="Contributions welcome"> | ||
| <img src="https://img.shields.io/badge/Contributions-Welcome-brightgreen?logo=github" /></a> | ||
| --- | ||
|
|
||
| <a href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg" alt="Slack"> | ||
| <img src=".github/slack.svg" /></a> | ||
| ## 📌 About This Repository | ||
|
|
||
| <a href="https://opensource.org/licenses/Apache-2.0" alt="License"> | ||
| <img src=".github/License-Apache_2.0-blue.svg" /></a> | ||
| </p> | ||
| 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! | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was no need to add the code of conduct here