https://github.com/keploy/python-sdk
https://github.com/keploy/python-sdk
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/keploy/python-sdk
- Owner: keploy
- License: apache-2.0
- Created: 2022-02-25T18:42:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T11:39:15.000Z (11 months ago)
- Last Synced: 2025-03-30T23:51:08.125Z (2 months ago)
- Language: Python
- Size: 58.6 KB
- Stars: 11
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](CODE_OF_CONDUCT.md)
[](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
[](https://opensource.org/licenses/Apache-2.0)
**Note** :- Issue Creation is disabled on this Repository, please visit [here](https://github.com/keploy/keploy/issues/new/choose) to submit issue.
# Keploy Python-SDK
This is the client SDK for the [Keploy](https://github.com/keploy/keploy) testing platform. With the Python SDK, you can test both your existing unit test cases in Pytest and create new end-to-end test cases for your applications.
The **HTTP mocks/stubs and tests are the same format** and inter-exchangeable.
## Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Community support](#community-support)
## Installation
1. First you need to install [Python(version 3 and above)](https://www.python.org/downloads/)
2. Install the Python-SDK and also Python's coverage library via pip.
```bash
pip install keploy coverage
```
3. Install Keploy from [here](https://github.com/keploy/keploy?tab=readme-ov-file#-quick-installation)
## Usage
Keploy simplifies the testing process by seamlessly generating end-to-end test cases without the need to write unit test files and manage mocks/stubs.
Add a test file with the following code to the directory with all your existing tests. This will help us to get the coverage of Keploy's API tests along with the other unit tests. We can call this `test_keploy.py`
```python
from keploy import run
def test_keploy():
run("python3 -m coverage run --data-file=.coverage_data.keploy ")
```
> Note: If you face any problems with running the coverage library, you can refer to the documentation for the same [here](https://coverage.readthedocs.io/en/7.4.2/cmd.html#execution-coverage-run)
To ignore the coverage of python libraries which are included in the report by default, you need to create a `.coveragerc` file in the directory where you will ignore the /usr/ directory(only for Linux users). The contents of the file will be as follows:
```bash
[run]
omit =
/usr/*
sigterm = true
```
Before starting your application, make sure that the **debug mode is set to False** in your application, for the coverage library to work properly.
Now to run this testcase along with your another unit testcases, you can run the command below:
```bash
keploy test -c "python3 -m coverage run -p --data-file=.coverage.unit -m pytest test_keploy.py " --delay 10 --coverage
```
Now, to combine the coverage from the unit tests, and Keploy's API tests, we can use the command below:
```bash
python3 -m coverage combine
```
Make sure to run this command before starting a new test run to avoid getting multiple coverage files.
Finally, to generate the coverage report for the test run, you can run:
```bash
python3 -m coverage report
```
and if you want the coverage in an html file, you can run:
```bash
python3 -m coverage html
```
Hooray🎉! You've sucessfully got the coverage of your Keploy recorded api tests using Pytest.
## Community support
We'd love to collaborate with you to make Keploy.io great. To get started:
* [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA) - Discussions with the community and the team.
* [GitHub](https://github.com/keploy/keploy/issues) - For bug reports and feature requests.