https://github.com/fangpenlin/bugbuzz-python

Fall in love with debugging
https://github.com/fangpenlin/bugbuzz-python

Last synced: about 1 month ago
JSON representation

Fall in love with debugging

• Host: GitHub
• URL: https://github.com/fangpenlin/bugbuzz-python
• Owner: fangpenlin
• License: mit
• Created: 2015-01-30T07:13:10.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-11-08T11:13:52.000Z (almost 3 years ago)
• Last Synced: 2024-07-08T14:07:13.674Z (2 months ago)
• Language: Python
• Size: 10.1 MB
• Stars: 103
• Watchers: 7
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bugbuzz - easy to use online debugger

[![Build Status](https://travis-ci.org/fangpenlin/bugbuzz-python.svg?branch=master)](https://travis-ci.org/fangpenlin/bugbuzz-python)

![Bugbuzz demo](/screencast.gif?raw=true )

# Relative projects

 - [Ember.js Dashboard project](https://github.com/fangpenlin/bugbuzz-dashboard)

 - [Backend API server project](https://github.com/fangpenlin/bugbuzz-api)

# Dashboard shortcuts

Vim style shortcuts

 - C Continue

 - H Return

 - J Next

 - L Step

# Usage

```

pip install bugbuzz

```

then insert following lines in your code to debug

```python

import bugbuzz; bugbuzz.set_trace()

```

# Security concerns

As bugbuzz providing debugging in a software-as-service manner, all source code and local variables needed will be uploaded to the server. When a debugging session created, a random secret access key will be generated, and used for encryping all source code and local variables. The access key will be passed to dashboard as a part of hash tag like this

```

http://dashboard.bugbuzz.io/#/sessions/SECsLArhHBVHF5mrtvXHVp3T?access_key=

```

With the access key, the Ember.js dashboard app can then decrypt the source code and local variables downloaded from the server. As the access key is passed as part of hash in the URL, the server cannot see it, without the access key, your source code and local variables are not visible by the server.

For more details about security topic, you can also read my article [Anonymous computing: Peer-to-peer encryption with Ember.js](http://fangpenlin.com/posts/2015/05/26/anonymous-computing-peer-to-peer-encryption-with-ember-js).

# Run demo

To run our demo

```bash

git clone --recursive [email protected]:fangpenlin/bugbuzz-python.git

```

install the project

```bash

virtualenv --no-site-packages .env

source .env/bin/activate

pip install -e .

```

and dependency used in the `demo.py`

```bash

pip install requests

```

then

```bash

python demo.py

```

It will open a new tab in your browser for debugging.

# Run with local API server and dashboard instead

By default, bugbuzz uses `bugbuzz-api.herokuapp.com` as the API server and `dashboard.bugbuzz.io` as the dashboard. To change this behavior, you can specify environment variables

 - **BUGBUZZ_API**: URL for the API server

 - **BUGBUZZ_DASHBOARD**: URL for the dashboard 

For example, you are running API server and the dashboard locally at `http://localhost:9090` and `http://localhost:4200`, then you can run bugbuzz like this

```bash

BUGBUZZ_API='http://localhost:9090' BUGBUZZ_DASHBOARD='http://localhost:4200' python demo.py

```

# Notice

 This is just a prototype, use it at your own risk