excel-tables 0.5.4
Python library to quickly export pandas tables to pretty, sensible Excel workbooks.
License: MIT
Requires Python: >=3.6

<div align="center">

# Excel-Tables<br>Finally a Python library to convert Pandas dataframes<br>to pretty Excel files,<br>for business people.

</div>

---
<!-- Use: markdown-toc -i README.md -->

<!-- toc -->

- [Excel-TablesFinally a Python library to convert Pandas dataframesto pretty Excel files,for business people.](#excel-tablesfinally-a-python-library-to-convert-pandas-dataframesto-pretty-excel-filesfor-business-people)
  - [Why Excel-Tables?](#why-excel-tables)
    - [The problem of Pandas in a business environment](#the-problem-of-pandas-in-a-business-environment)
    - [The solution](#the-solution)
    - [What Excel-Tables is not](#what-excel-tables-is-not)
    - [Cautions](#cautions)
  - [How to install](#how-to-install)
  - [Usage](#usage)
    - [Simple example](#simple-example)
    - [A more elaborate report](#a-more-elaborate-report)
  - [Advanced Usage](#advanced-usage)
    - [Report with several worksheets](#report-with-several-worksheets)
    - [Redefining a Report or a Worksheet](#redefining-a-report-or-a-worksheet)
    - [Reworking the file in openpyxl](#reworking-the-file-in-openpyxl)
  - [Basic rules](#basic-rules)
    - [General format decisions](#general-format-decisions)
    - [General Number formats](#general-number-formats)
    - [Format for specific columns in a Worksheet](#format-for-specific-columns-in-a-worksheet)
    - [Worksheet headers](#worksheet-headers)
  - [Reading an Existing Excel File as a Database](#reading-an-existing-excel-file-as-a-database)
    - [Introduction](#introduction)
    - [Initializing](#initializing)
    - [Initializing with a single table](#initializing-with-a-single-table)
    - [Adding a dataframe (from some other origin)](#adding-a-dataframe-from-some-other-origin)
    - [Making a query](#making-a-query)
    - [Adding the tables from another Excel file](#adding-the-tables-from-another-excel-file)
    - [Dropping a table](#dropping-a-table)
    - [Note on dates](#note-on-dates)
  - [License](#license)

<!-- tocstop -->

## Why Excel-Tables?

### The problem of Pandas in a business environment

Companies rely on databases to store their data, but
only a fraction of the staff know how to query one.  

Today, their main tool of work is a spreadsheet: **Microsoft Excel**.

Pandas is great for querying relational databases quickly,
or importing tables in a variety of formats. It also exports dataframes to Excel very well. It's a perfect tool for business use.

> :warning: **Warning**
> However, the resulting Excel files are bland:
> no colors, no number formatting, etc.
> In a business environment, one cannot present an unformatted Excel
> file to a colleague; this is considered poor work.
> There are minimal standards for Excel spreadsheets.

Therefore, every time one does any data extraction,
one has to spend _manually_ **five minutes or up to a quarter of an hour**,
to reformat the file so that it can presented to someone else.

And if a new extraction is required, even five minutes later,
everything has to be redone!

**This is a huge amount of tedious, repetitive work.**

### The solution

What if it was possible to export one or more tables into an Excel file,
with the assurance that

- It would look good or almost good at the first attempt, with
   numbers or dates properly displayed, with nicely formatted header columns?

- One could adjust the format of some columns without
  jumping into a rabbit hole?

The solution? ** Excel-Tables**. It allows you to create Excel 
reports with one or more tables in it.

It is a higher standard than the plain Excel export from Pandas.

### What Excel-Tables is not

- It is not a tool that allows maximum flexibility in the presentation
of tables.

- It is not a diagram tool.

- It was not developed with scientific applications in mind. 
  It might become slow for large datasets.

### Cautions

** What we mean by _table_ is simple: a header row, and rows,
as in the extraction from a a relational database table.**

Excel-Tables is very standard in its presentation (opinionated), to keep
things maximally simple.
It looks nice, but don't expect bells and whistles.

In order to use it comfortably, you should first adhere to its
basic philosophy and choices.

**As a last resort, you could still use the openpyxl library to rework the report.**
  



## How to install


```sh
pip install excel_tables
```


## Usage

### Simple example

```python
from excel_tables import ExcelReport
report = ExcelReport('Myfile.xlsx', df=df)
```

If you specify a dataframe at this stage, the report is immediately saved
to an Excel file.

### A more elaborate report

Specifies the font (Helvetica) and emphasizes (bold) the lines
where the second column (1) is higher than 1000.

(Emphasis is displayed with a yellow background).

```python
from excel_tables import ExcelReport
my_file = 'Myfile.xlsx'
report = ExcelReport(my_file, 
                    font_name='Helvetica', 
                    df=df,
                    num_formats={'Rate': "#'##0.0000"},
                    emphasize=lambda x: x[1] > 1000)
report.rich_print()
report.open()
```

- `num_formats` is used to specify additional formats for columns,
  if the default are not appropriate. It is a dictionary of columns, Excel formats.
- `rich_print()` prints a simplified view of the report on the console.
- `open()` opens the file in the standard Excel app.



## Advanced Usage

### Report with several worksheets

```python
from excel_tables import ExcelReport

report = ExcelReport(second_out_file, 
                    font_name='Times New Roman', 
                    format_int="[>=1000]#'##0;[<1000]0",
                    format_float="[>=1000]#'##0.00;[<1000]0.00")

report.add_sheet('Income', df1, emphasize=lambda x: x[1] > 20000,
                        num_formats={'Feet': "#'##0"})

# add other attributes
wks = report.add_sheet('Expenses', df2, num_formats={'Rates': "#'##0.0000"})
wks.header_color = "light_blue"
report.save(open_file=True)
```

Since no dataframe is provided when the report objected is created,
no auto_save is done; you must do it explicitly, after having
appended the worksheets.

- `format_int`: a specification for all integer columns, valid for the
   whole report.
- `format_float`: a specification for all float columns, valid for the
   whole report.

For worksheets:
- `num_formats` is used to specify additional formats for columns,
  if the default are not appropriate. It is a dictionary of columns, Excel formats.`num_formats` is a dictionary of column names and Excel numeric formats.



### Redefining a Report or a Worksheet
You can can also specify arguments in this way:

```python
from excel_tables import ExcelReport

report = ExcelReport(second_out_file)
report.font_name='Times New Roman', 
report.format_int="[>=1000]#'##0;[<1000]0",
report.format_float="[>=1000]#'##0.00;[<1000]0.00"
```

Another way of defining a worksheet is by explicitly creating a worksheet
object

```python
from excel_tables import ExcelReport, Worksheet
report = ExcelReport(second_out_file)
wks = Worksheet('Income', df1, emphasize=lambda x: x[1] > 20000,
                        num_formats={'Feet': "#'##0"})
report.append(wks)
```

> :memo: **Note**
> Using the Worksheet object has the advantage that all available attributes
> of the Worksheet are immediately available, without needing
> to redefine them.


### Reworking the file in openpyxl

In the unlikely case you wish to rework a report using the 
[openpyxl library](https://openpyxl.readthedocs.io/en/stable/).

An ExcelReport object has an attribute `workbook`.



```python
wb = report.workbook
# Get the 'Main' worksheet (as in the tab)
first_sheet = wb.worksheets['Main']

...
wb.save(myfile)
```

> :warning: **Warning**
> Keep in mind that the ExcelReport `Worksheet` class is not the same as the one in openpyxl.

## Basic rules

### General format decisions
1. Worksheets have no background and no grid for the cells
  (complete white).
2. A simple grid is applied to the cells of each table.
3. The font color for the data is black.
4. All tables have autofilter.

### General Number formats
For Excel, float, int or datetimes are all numbers.

excel_tables formats number according to its own logic



Internal Format  | Python Type | System Default | Your default
---------------- | ----------- | ------- | -------
integer | int |  No decimals, comma separator for thousands | `format_int`
float | float |  2 decimals, comma separator for thousands | `format_float`
percentage | float (between 0 and 1) | % symbol, 1 decimal | `format_perc`
date | datetime (no hours and minutes) | ISO (YYY-MM-DD) | `format_date`
datetime | datetime | ISO (YYYY-MM-DD HH:MM:SS) | N/A

The console printer adopts English conventions for numbers, and ISO for dates.

### Format for specific columns in a Worksheet
You can specify exceptions to the above defaults, 
for each column of a Worksheet object.

This is done with the `numformats` attribute, which is a dictionary
of columns.

```python
wks = Worksheet('Mountains', df, 
            num_formats={'Rates': "#,##0.0000", "Quality": "0.00%"})
```

or, once the worksheet has already been created:


```python
myworkbook.num_formats = {'Rates': "#,##0.0000", "Quality": "0.00%"}
```



This is field is also present in the ExcelReport; it is used
when a dataframe (df) is specified.

### Worksheet headers
1. Headers are all treated in the same way, with a default background color.
2. You can specify a default header background color for the whole report,
   or a specific header color for each workbook.
3. According to the luminance of the background color, the text of each
   header will be black or white.
4. Color names (HTML 4, CSS > 2) or color hexa representation (string) can be used.

```python
wks = Worksheet('Mountains', df, header_color='ligthblue')
```

or, once the worksheet has already been created:

```python
wks.header_color = 'ligthblue'
```
## Reading an Existing Excel File as a Database

### Introduction

Sometimes it is useful to consider an existing Excel file
as a database that can be queried, typically
to perform filters or joins on tables, and then integrate the result
into an ExcelReport.


### Initializing

This loads all tabs (worksheets) from an Excel file into memory:

```python
from excel_tables import ExcelDB
xldb = ExcelDB('my_file.xlsx')
```

If you want to have database file to be kept on disk, use the 
optional parameter `db_filename`:
```python
xldb = ExcelDB('my_file.xlsx', db_filename='my_file.db')
```

### Initializing with a single table

To load a single tab (worksheet) as a table, use the `load_wks()` method;
you can use the worksheet number if you wish.
The `tablename` argument is optional (if absent, the method will figure
out the name).

```python
from excel_tables import ExcelDB
xldb = ExcelDB()
xldb.import_wks('my_file.xlsx', sheetname=1, tablename='mytable')
```

By default, it replaces all tables with the same name with the current one.
If you want to prevent that, add the argument `replace=False`.

### Adding a dataframe (from some other origin)

You can easily add a Pandas dataframe from any origin:

```python
xldb.load('mytable', df)
```

By default, it replaces a previous table with the same name 
with the current one.
If you want to prevent that, add the argument `replace=False`.

### Making a query

```python
MAX = 80

MYQUERY = """
  SELECT * 
  FROM Foo
  LEFT JOIN [Bar baz]
  ON Foo.x = [Bar baz].[First Column]
  WHERE Foo.x > :MAX
"""
df = xldb.query(MY_QUERY)
```

You can use Python [SQLite3 placeholders for values](https://docs.python.org/3/library/sqlite3.html#how-to-use-placeholders-to-bind-values-in-sql-queries)
(but not table or column names; for those you might need f-strings).

In this case, `:MAX` is a parameter that refers to an existing variable
name in the local environment.

If you wish you can pass a list or dictionary of parameters e.g.:

```python
df = xldb.query(MY_QUERY, params={'foo'=5, 'bar'=8})
```

Then you could easily use that dataframe into an `ExcelReport` object:

```python
report = ExcelReport('my_file.xlsx', ...) 
...
report.add_sheet('tabname', df)
...
report.save()
```



### Adding the tables from another Excel file

```python
xldb.import_file('second_file.xlsx')
```

By default, it replaces previous tables with the same name 
with the ones in that file.
If you want to prevent that, add the argument `replace=False`.

### Dropping a table

If you want to remove a table from the database:

```python
xldb.drop('mytable')
```


### Note on dates

SQLite stores dates as ISO strings; however, the dataframes
generated from queries automatically detect them and reconverts
them as Datetime objects, which will be correctly processed by
the `ExcelReport` class.


## License

**This project is licensed under the MIT License.**


**Excel** is a registered trademark of Microsoft Corporation.

This project is not affiliated with, endorsed by, or in any way associated with Microsoft Corporation.

The **'.xlsx' format** is a standard, part of the
Office Open XML (OOXML) format,
standardized by ECMA (ECMA-376) and ISO/IEC (ISO/IEC 29500).
It is licensed under the [Open Specification Promise by Microsoft](https://learn.microsoft.com/en-us/openspecs/dev_center/ms-devcentlp/1c24c7c8-28b0-4ce1-a47d-95fe1ff504bc).