xl-link 0.133
Excel spreadsheets made easy through Pandas magic
License: MIT
Requires Python: >=3.4
Keywords: pandas,excel,io,data,charts,graphs

# XLLink for Pandas

**Quick-start: https://0hughman0.github.io/xl_link/quickstart.html**

**Installation: `pip install xl_link`**

XLLink aims to provide a powerfull interface between Pandas DataFrames, and Excel spreadsheets.

XLLink tweaks the DataFrame.to_excel method to return its own XLMap object.

This XLMap stores all the information about the location of the written DataFrame within the spreadsheet.

By allowing you to use Pandas indexing methods, i.e. loc, iloc, at and iat. XLLink remains intuitive to use. But instead of returning a DataFrame, Series, or scalar, XLMap will instead return the XLRange, or XLCell corresponding to the location of the result within your spreadsheet.

Additionally XLMaps offer a wrapper around excel engines (currently supporting xlsxwriter and openpyxl) to make creating charts in excel far more intuitive. Providing a DataFrame.plot like interface for excel charts.

## Chart demo

creating a complex chart is as easy as:

    >>> f = XLDataFrame(index=('Breakfast', 'Lunch', 'Dinner', 'Midnight Snack'),
                        data={'Mon': (15, 20, 12, 3),
                              'Tues': (5, 16, 3, 0),
                              'Weds': (3, 22, 2, 8),
                              'Thur': (6, 7, 1, 9)})
    >>> xlmap = f.to_excel('Chart.xlsx', sheet_name="XLLinked", engine='openpyxl')
    >>> xl_linked_chart = xlmap.create_chart('bar', title="With xl_link", x_axis_name="Meal", y_axis_name="Calories", subtype='col')
    >>> xlmap.sheet.add_chart(xl_linked_chart, 'F1')
    >>> xlmap.writer.save()

Producing this chart:

![multi bar chart](https://raw.githubusercontent.com/0Hughman0/xl_link/master/examples/BarExample.png)


## Formatting demo

Applying conditional formatting to a table is as easy as:

    >>> import numpy as np
    >>> xy_data = XLDataFrame(data={'Y1': np.random.rand(10) * 10,
                                    'Y2': np.random.rand(10) * 10})
    >>> xlmap = xy_data.to_excel("ConditionalFormatting.xlsx", engine='xlsxwriter')
    >>> xlmap.sheet.conditional_format(xlmap.data.range, # position of data within spreadsheet
                                       {'type': '3_color_scale',
                                        'min_type': 'num', 'min_value': xlmap.f.min().min(), 'min_color': 'green',
                                        'mid_type': 'num', 'mid_value': xlmap.f.mean().mean(), 'mid_color': 'yellow',
                                        'max_type': 'num', 'max_value': xlmap.f.max().max(), 'max_color': 'red'})
    >>> xlmap.writer.save()

![conditional formatting](https://raw.githubusercontent.com/0Hughman0/xl_link/master/examples/ConditionalFormattingExample.png)

Check out the examples folder for more examples!

This package uses the utility functions from XlsxWriter under the BSD license found here: https://github.com/jmcnamara/XlsxWriter

## Compatibility

`pandas >= 0.19`
`Xlsxwriter >= 0.9`
`openpyxl >= 2.4`

latest tested versions:

`pandas==0.23.4`
`XlsxWriter==1.0.7` - (potential issue with stock chart, using openpyxl recommend if desired)
`openpyxl==2.5.5`

Copyright (c) 2018 0Hughman0

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.