Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cle-b/httpdbg
A tool for Python developers to easily debug the HTTP(S) client requests in a Python program.
https://github.com/cle-b/httpdbg
aiohttp debug http httpdbg httpx pyhttpdbg pytest pytest-xdist python python-requests requests rest rest-api tools urllib3
Last synced: 13 days ago
JSON representation
A tool for Python developers to easily debug the HTTP(S) client requests in a Python program.
- Host: GitHub
- URL: https://github.com/cle-b/httpdbg
- Owner: cle-b
- License: apache-2.0
- Created: 2020-06-21T13:08:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-14T15:19:38.000Z (8 months ago)
- Last Synced: 2024-03-14T16:48:28.177Z (8 months ago)
- Topics: aiohttp, debug, http, httpdbg, httpx, pyhttpdbg, pytest, pytest-xdist, python, python-requests, requests, rest, rest-api, tools, urllib3
- Language: Python
- Homepage: https://httpdbg.readthedocs.io/
- Size: 633 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# httpdbg
`httpdbg` is a tool for Python developers to easily debug the HTTP(S) client requests in a Python program.
To use it, execute your program using the `pyhttpdbg` command instead of `python` and that's it. Open a browser to `http://localhost:4909` to view the requests:
Full documentation => [https://httpdbg.readthedocs.io/](https://httpdbg.readthedocs.io/en/latest/)
## installation
```
pip install httpdbg
```
## usage
### interactive console
Open an interactive console using the command `pyhttpdbg`.
```console
(venv) dev@host:~/dir$ pyhttpdbg
.... - - .--. -.. -... --. .... - - .--. -.. -... --. .... - - .--. -.. -... --.
httpdbg - HTTP(S) requests available at http://localhost:4909/
.... - - .--. -.. -... --. .... - - .--. -.. -... --. .... - - .--. -.. -... --.
Python 3.10.6 (main, Aug 10 2022, 11:40:04) [GCC 11.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>>
```
Perform HTTP requests.
You can inspect the HTTP requests directly in your web browser at http://localhost:4909.
### script
You can trace all the HTTP requests performed by a script
```console
pyhttpdbg --script filename.py [arg1 --arg2 ...]
```
### pytest
You can trace all the HTTP requests performed during your tests
```console
pyhttpdbg -m pytest [arg1 --arg2 ...]
```
If you use the `pytest-xdist` plugin to execute your tests in parallel, then you must install the `pytest-httpdbg` plugin if you want to trace the requests done by the pytest workers.
```console
pip install httpdbg[pytest]
```
### module
You can trace all the HTTP requests performed by a library module run as a script using the `-m` command line argument.
For example, you can view which HTTP requests are performed by `pip` when you install a package.
```console
pyhttpdbg -m pip install hookdns --upgrade
```
## Initiators
An initiator is the function/method that is at the origin of the HTTP requests. By default, we already support some packages but you can add your own initiators.
To add a new package in the list of initiators, you can use the `-i` command line argument:
```console
pyhttpdbg -i api_client_pck --script my_script.py
```
You can use any package as an initiator, this is not limited to HTTP requests.
### Already supported packages
| packages | status |
|----------------|-------------------------------------|
| requests | supported |
| urllib3 | supported |
| httpx | supported |
| aiohttp | supported |
| pytest | supported |
| _your_package_ | yes, with the arg _-i your_package_ |
## configuration
No configuration is necessary to start but some few settings are available for particular use.
### command line
```console
usage: pyhttpdbg [-h] [--host HOST] [--port PORT] [--version] [--initiator INITIATOR] [--keep-up | --force-quit]
[--console | --module MODULE | --script SCRIPT]
httdbg - a very simple tool to debug HTTP(S) client requests
options:
-h, --help show this help message and exit
--host HOST the web interface host IP address
--port PORT, -p PORT the web interface port
--version, -v print the httpdbg version
--initiator INITIATOR, -i INITIATOR
add a new initiator (package)
--keep-up, -k keep the server up even if the requests have been read
--force-quit, -q stop the server even if the requests have not been read
--console run a python console (default)
--module MODULE, -m MODULE
run library module as a script (the next args are passed to pytest as is)
--script SCRIPT run a script (the next args are passed to the script as is)
```
### web interace
Clic on the **⚙** button on the top right of the page.
Some options are available:
* Hide the netloc in the url
* Hide the initiator rows
* Hide the tags
To keep your configuration, bookmark the page with the full search query.
Fox example, if you want to hide the initiator rows by default, the url will be:
```
http://localhost:4909/?hi=on
```
## web interface
All the requests recorded are available on the web interface.
The requests:
* are still available in the web page even if the python process stopped (except if you force quit before the requests have been loaded by the web page).
* are automatically cleaned if a new execution is detected.
## documentation
https://httpdbg.readthedocs.io