Skip to content

minor phrasing fixes #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sonariorobot merged 1 commit into from
Oct 28, 2018
Merged

minor phrasing fixes #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
# Rookout official tutorial for using Python
# 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)

This is the official [rookout][rookout-getting-started] Python tutorial
A sample app for debugging Python using [Rookout][rookout-getting-started].

## Helpful links:

- [Signup][rookout-signup]
- [Documentation][docs-url]
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Setup](#setup)
- [Usage](#usage)
- [License](#license)
- [Sign up to Rookout][rookout-signup]
- [Online Documentation][docs-url]


## Prerequisites

1. Python 2.7.14 or newer
1. Optional - Docker - https://www.docker.com/get-docker
2. Optional - Docker - https://www.docker.com/get-docker

## Installation
## Setup

1. Clone this repo
3. Clone the sample app from this repository:

```bash
git clone https://github.com/Rookout/tutorial-python.git
cd tutorial-python
```

1. Set your Rookout token in an ENV variable (replace **export** by **set** if on Windows)
4. Set your Rookout token as an environment variable (for Windows, use ***set*** instead of **export**)

```bash
export ROOKOUT_TOKEN=[Your Rookout Token]
```

1. Run the app

- Option 1 - Without Docker:
5. Run the app:

```bash
pip install -r requirements.txt
python app.py
```

- Option 2 - Running with docker
- Optional - Run the app using Docker:

```bash
docker build . -t tutorial-python
Expand All @@ -53,7 +53,7 @@ docker run -p 5000:5000 -e ROOKOUT_TOKEN=$ROOKOUT_TOKEN tutorial-python

## Usage

- After running the app go to [https://app.rookout.com/][rookout-app-url] and **Log In**
- Log in to [the Rookout IDE][rookout-app-url].
- Add the source code according to the instructions using the left pane **Source View**

<details>
Expand Down