Skip to content

Commit

Permalink
Merge
Browse files Browse the repository at this point in the history
  • Loading branch information
arnoutaertgeerts committed May 22, 2015
2 parents c7bdfd7 + cd2cb75 commit 8d98158
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,33 @@ pip install charts
```

## Quick start
Checkout this [notebook](http://nbviewer.ipython.org/github/arnoutaertgeerts/python-highcharts/blob/master/Quickstart.ipynb)!

First import the library:
```python
import charts
```

Second load some example data from the `data` module and some default options from the `options` module:
```python
aapl = charts.data.aapl()
msft = charts.data.msft()
ohlc = charts.data.ohlc()

ohlc['display'] = False

series = [
aapl,
msft,
ohlc
]
options = charts.options.default()
```

And finally plot the chart! Use `inline=True` if you are in an IPython notebook and `inline=False` otherwise.
```python
charts.plot(series, options, height=500, stock=True, inline=True)
```

Don't be affraid to play with the chart, it's interactive :) Try typing in `OHLC` in the variable selector or viewing a different time period by squeezing the bottom scroll bar!

For more, checkout this [notebook](http://nbviewer.ipython.org/github/arnoutaertgeerts/python-highcharts/blob/master/Quickstart.ipynb)!

0 comments on commit 8d98158

Please sign in to comment.