Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isaacbernat/docker-pudb
Debug Python code within a Docker container remotely from your terminal using pudb
https://github.com/isaacbernat/docker-pudb
debug debugger debugging debugging-tool debugging-tools docker docker-compose dockerfile hacktoberfest ipdb pdb pudb python python2 python27 python3 telnet
Last synced: about 1 month ago
JSON representation
Debug Python code within a Docker container remotely from your terminal using pudb
- Host: GitHub
- URL: https://github.com/isaacbernat/docker-pudb
- Owner: isaacbernat
- License: mit
- Created: 2018-07-18T09:48:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T21:44:44.000Z (3 months ago)
- Last Synced: 2024-10-07T22:27:51.325Z (about 1 month ago)
- Topics: debug, debugger, debugging, debugging-tool, debugging-tools, docker, docker-compose, dockerfile, hacktoberfest, ipdb, pdb, pudb, python, python2, python27, python3, telnet
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 23
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-pudb
Debug Python code within a Docker container remotely from your terminal using pudb.
## Prerequisites:
- [Python](https://docs.python.org/3/index.html) (versions 2.7 and 3.6+ supported)
- [Docker](https://docs.docker.com/)
- [pudb](https://documen.tician.de/pudb/)
- [telnet client](https://en.wikipedia.org/wiki/Telnet)
## How to do it?
### Python
Just add the following line wherever you want you entry point to be:
```python
from pudb.remote import set_trace; set_trace(term_size=(160, 40), host='0.0.0.0', port=6900)
```
If you wanted to debug using `pudb` locally you'd write instead:
```python
import pudb; pu.db
```
Which is similar to how one would do it for the built-in pdb:
```python
import pdb; pdb.set_trace()
```
### Docker
#### Dockerfile
- `pudb` needs to be installed on the Docker image. One way to do it is adding this line to the Dockerfile:
```
RUN pip install pudb
```
- The port `pudb` is listening to must be open. In our example it is 6900. One way to do it is adding to your Dockerfile:
```
EXPOSE 6900
```
#### docker-compose
If you use docker-compose yml files the syntax is different. You should add:
```
ports:
- "6900:6900"
```
### Telnet
**Mac users:** If you don't have any `telnet` client, you can install one via [Homebrew](https://brew.sh/). Type `brew install telnet` on your terminal.
When all above is done, run the container. When the entrypoint is reached, the code execution will stop. Then you need to connect to it via a telnet client, e.g. `telnet 127.0.0.1 6900`. Now you will see the `pudb` screen and debugging can start :D
## Try it out!
Clone this repository and from its root folder run:
```sh
# Optional: try it on Python 2.7 instead of 3.6+
cd python2
# Build the Docker image
docker build -t pudb-example .
# Run the container (in the background) exposing port 6900
docker run -p 6900:6900 --detach pudb-example
# Connect to pudb via telnet
telnet 127.0.0.1 6900
# Enjoy debugging and star the repo if you liked it!
```
## Acknowledgements
- Inspiration came from [this blog post](http://kartowicz.com/dryobates/2016-09/debugging_gunicorn_on_docker_with_pudb/). There was no code readily available to try it out, so I created this repository.
- This repository is used as a reference for this related [Stack Overflow entry](https://stackoverflow.com/questions/36885957/running-pudb-inside-docker-container/51404762#51404762)