Copy as Python

A request action plugin for Yaak that converts HTTP requests into python code, making it easy to share, debug, and execute requests outside Yaak.

Overview

This plugin adds a ‘Copy as Python’ action to HTTP requests, converting any request into its equivalent python code. This is useful for debugging, sharing requests with team members, and executing requests in terminal environments where python is available.

How It Works

The plugin analyzes the given HTTP request and generates properly formatted python code that includes:

• HTTP method (GET, POST, PUT, DELETE, etc.)
• Request URL with query parameters
• Headers (including authentication headers)
• Request body (for POST, PUT, PATCH requests)
• Authentication credentials

Usage

1. Configure an HTTP request as usual in Yaak
2. Right-click on the request in the sidebar
3. Select ‘Copy as Python’
4. The code is copied to your clipboard
5. Share or execute the code

Generated Python Examples

Simple GET Request

import requests

url = 'https://api.example.com/users'

response = requests.get(url)
print(response.text)

POST Request with JSON Data

import requests

url = 'https://api.example.com/users'
headers = {'Content-Type': 'application/json'}
payload = {'name': 'John Doe', 'email': 'john@example.com'}

response = requests.post(url, headers=headers, json=payload)
print(response.text)

Repeated Query Parameters

import requests

url = 'https://api.example.com/users'
params = [('tag', 'urgent'), ('tag', 'billing')]

response = requests.get(url, params=params)
print(response.text)

GraphQL Request

import requests

url = 'https://api.example.com/graphql'
payload = {'query': 'query GetUser($id: ID!) {\n  user(id: $id) {\n    name\n  }\n}', 'variables': {'id': '42'}}

response = requests.post(url, json=payload)
print(response.text)

Request with Multi-part Form Data

import requests

url = 'https://api.example.com/upload'
payload = {'hello': 'world'}
files = { 'file': ('file.json', open('/path/to/file.json', 'rb')) }

response = requests.post(url, files=files, data=payload)
print(response.text)

Request with Authentication

import requests

url = 'https://api.example.com/protected'

response = requests.get(url, auth=('username', 'password'))
print(response.text)

Non-standard HTTP Method

import requests

url = 'https://api.example.com/cache/users'

response = requests.request('PURGE', url)
print(response.text)

Development

npm install
npm run typecheck   # type-check src/
npm test            # run the vitest suite
npm run build       # bundle to build/index.js

Tests assert on the generated source and, where a Python interpreter is available, parse each snippet with Python itself to guarantee it is valid.