# Rookout tutorial for debugging Python applications [![CircleCI](https://circleci.com/gh/Rookout/tutorial-python/tree/master.svg?style=svg)](https://circleci.com/gh/Rookout/python/tree/master) [![License][license-image]][license-url] [![Docs][docs-image]][docs-url] [![GitHub version][version-badge]](https://badge.fury.io/gh/rookout%2Ftutorial-python) A sample app for debugging Python using [Rookout][rookout-getting-started]. ## Helpful links: - [Prerequisites](#prerequisites) - [Setup](#setup) - [Usage](#usage) - [License](#license) - [Sign up to Rookout][rookout-signup] - [Online Documentation][docs-url] ## Prerequisites 1. Python 2.7.14 or newer 2. pip 3. Optional - Docker - https://www.docker.com/get-docker ## Setup 3. Clone the sample app from this repository: ```bash git clone https://github.com/Rookout/tutorial-python.git cd tutorial-python ``` 4. Set your Rookout token as an environment variable (for Windows, use ***set*** instead of **export**) ```bash export ROOKOUT_TOKEN=[Your Rookout Token] ``` 5. Run the app: ```bash pip install -r requirements.txt python app.py ``` - Optional - Run the app using Docker: ```bash docker run -p 5000:5000 -e ROOKOUT_TOKEN=$ROOKOUT_TOKEN rookout/tutorial-python ``` ## Usage - Log in to [the Rookout IDE][rookout-app-url]. - Add the source code according to the instructions using the left pane **Source View**

More details

#### Adding source code 1. Click on Add source 1. Choose source control - Github - Click on Connect - Authorize O-Auth - Fill `Repository Owner` - Click `Repository` and choose from the dropdown menu - Click Next - Choose the desired branch - Click View Repository - Local FileSystem - Server - Click on Setup Server - Choose a supported HTTP Server - Follow the on-screen instructions

- Open the file `app.py` - Add a Snapshot Breakpoint next to line number 84 by clicking next the the line number in the file viewer - Looking at the right-hand pane **Breakpoints**, you will see the Breakpoint you added, on what line you added it and it should be GREEN, meaning everything is communicating correctly. - If this is not the case, [click here](https://docs.rookout.com/docs/breakpoints-status.html) to see how to fix that - Go the the app webpage http://localhost:5000/ and add a todo in order to trigger the Breakpoint - Check the bottom pane **Messages** and you'll see the snapshot you just added, as it was triggered by the handler of the web api when you added a todo Go through the [bug list](https://docs.rookout.com/docs/sample-applications.html#bug-hunt) and follow instructions to see some basic use cases. ## Common Pitfalls - Breakpoint status is RED -- Hash mismatch. It means the file used in the server is not the same file used from github/local server in app.rookout.com - Breakpoint status is GRAY -- No app connected. Make sure you have inserted the Rookout Token in the right place and that connection is made properly. ## Want to learn more ? - [Our documentation][docs-url] for more information - [our deployment examples][deployment-examples] for platform-specific integration examples ## License [APACHE 2](LICENSE) [version-badge]: https://badge.fury.io/gh/rookout%2Ftutorial-python.svg [license-url]: LICENSE [docs-url]: https://docs.rookout.com/ [rookout-getting-started]: https://docs.rookout.com/docs/welcome.html [rookout-signup]: https://www.rookout.com/trial/ [docs-image]: https://img.shields.io/badge/docs-latest-blue.svg [license-image]: https://img.shields.io/badge/License-Apache%202.0-blue.svg [rookout-app-url]: https://app.rookout.com/ [deployment-examples]: https://github.com/Rookout/deployment-examples