Skip to content

DOCS: Overhaul of all the DOCS in samples-python #69

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.

Sign up for GitHub

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DOCS: Overhaul of all the DOCS in samples-python #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
984fe65
Improvement of the DOCS SP
V-Silpin Jun 23, 2025
51044a2
Improvement of the DOCS SM
V-Silpin Jun 23, 2025
900ddaf
Improvement of the DOCS FR
V-Silpin Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions flask-redis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,37 @@ If homebrew is not installed, then go to https://brew.sh/ and install it.

```bash
git clone https://github.com/keploy/samples-typescript && cd samples-typescript/flask-redis

# Install the dependencies
pip3 install -r requirements.txt
```

1. Create a Virtual Environment:

```bash
python -m venv venv
```
2. Activating the Virtual Environment
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually a good suggestion to add the virtual environement


On Windows:

```bash
venv\Scripts\activate
```

On macOS and Linux:

```bash
source venv/bin/activate
```
3. Install the required Python packages:

```bash
pip install -r requirements.txt
```
4. To exit your Virtual Environment:

```bash
deactivate
```

# Installing Keploy

Let's get started by setting up the Keploy alias with this command:
Expand Down
37 changes: 34 additions & 3 deletions sanic-mongo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,40 @@ alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --pr

Now head to the folder of the application and run

```
pip3 install -r requirements.txt
```
1. Navigate your project directory:

```bash
cd sample-python/sanic-mongo
```

2. Create a Virtual Environment:

```bash
python -m venv venv
```
3. Activating the Virtual Environment

On Windows:

```bash
venv\Scripts\activate
```

On macOS and Linux:

```bash
source venv/bin/activate
```
4. Install the required Python packages:

```bash
pip install -r requirements.txt
```
5. To exit your Virtual Environment:

```bash
deactivate
```

### Lights, Camera, Record! 🎥

Expand Down
38 changes: 34 additions & 4 deletions sanic-postgres/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,41 @@ Once you have the prerequisites set up, follow these steps:
```bash
git clone https://github.com/keploy/sample-python.git
cd sample-python
Install the required Python packages:

```bash
pip install -r requirements.txt
```
2. Navigate your project directory:

```bash
cd sample-python/sanic-postgres
```

3. Create a Virtual Environment:

```bash
python -m venv venv
```
4. Activating the Virtual Environment

On Windows:

```bash
venv\Scripts\activate
```

On macOS and Linux:

```bash
source venv/bin/activate
```
5. Install the required Python packages:

```bash
pip install -r requirements.txt
```
6. To exit your Virtual Environment:

```bash
deactivate
```

Set up your PostgreSQL database and update the connection settings in your application as needed.

Expand Down