fix #676 : implemented ExcelReport class to generate an Excel file with multiple graphs at once

Author: alixdamman

MANIFEST.in

@@ -1,2 +1,3 @@
 include COPYING
-recursive-include larray/tests/data *.csv *.xlsx *.h5
+recursive-include larray/tests/data *.csv *.xlsx *.h5
+recursive-include larray/tests/excel_template *.crtx

doc/source/api.rst

@@ -675,6 +675,37 @@ Excel
    Workbook.close
    Workbook.app
 
+ExcelReport
+===========
+
+.. autosummary::
+   :toctree: _generated/
+
+   ExcelReport
+   ExcelReport.template_dir
+   ExcelReport.template
+   ExcelReport.set_item_default_size
+   ExcelReport.graphs_per_row
+   ExcelReport.new_sheet
+   ExcelReport.sheet_names
+   ExcelReport.to_excel
+
+ReportSheet
+===========
+
+.. autosummary::
+   :toctree: _generated/
+
+   ReportSheet
+   ReportSheet.template_dir
+   ReportSheet.template
+   ReportSheet.set_item_default_size
+   ReportSheet.graphs_per_row
+   ReportSheet.add_title
+   ReportSheet.add_graph
+   ReportSheet.add_graphs
+   ReportSheet.newline
+
 .. _api-misc:
 
 Miscellaneous

doc/source/changes/version_0_31.rst.inc

@@ -18,30 +18,8 @@ Backward incompatible changes
 New features
 ^^^^^^^^^^^^
 
-* added a feature (see the :ref:`miscellaneous section <misc>` for details). It works on :ref:`api-axis` and
-  :ref:`api-group` objects.
-
-  Here is an example of the new feature:
-
-    >>> arr = ndtest((2, 3))
-    >>> arr
-    a\b  b0  b1  b2
-     a0   0   1   2
-     a1   3   4   5
-
-  And it can also be used like this:
-
-    >>> arr = ndtest("a=a0..a2")
-    >>> arr
-    a  a0  a1  a2
-        0   1   2
-
-* added another feature in the editor (closes :editor_issue:`1`).
-
-  .. note::
-
-     - It works for foo bar !
-     - It does not work for foo baz !
+* added the :py:obj:`ExcelReport` class allowing to generate multiple graphs in an
+  Excel file at once (closes :issue:`676`).
 
 
 .. _misc:

larray/__init__.py

@@ -30,6 +30,7 @@
 from larray.inout.sas import read_sas
 from larray.inout.stata import read_stata
 from larray.inout.xw_excel import open_excel, Workbook
+from larray.inout.xw_reporting import ExcelReport
 
 # just make sure handlers for .pkl and .pickle are initialized
 import larray.inout.pickle as _pkl
@@ -41,7 +42,7 @@
 
 from larray.extra.ipfp import ipfp
 
-from larray.example import get_example_filepath, load_example_data
+from larray.example import get_example_filepath, load_example_data, EXAMPLE_EXCEL_TEMPLATES_DIR
 
 import larray.random
 
@@ -75,15 +76,16 @@
     'real_if_close', 'interp', 'isnan', 'isinf', 'inverse',
     # inout
     'from_lists', 'from_string', 'from_frame', 'from_series', 'read_csv', 'read_tsv',
-    'read_eurostat', 'read_excel', 'read_hdf', 'read_sas', 'read_stata', 'open_excel', 'Workbook',
+    'read_eurostat', 'read_excel', 'read_hdf', 'read_sas', 'read_stata',
+    'open_excel', 'Workbook', 'ExcelReport',
     # utils
     'get_options', 'set_options',
     # viewer
     'view', 'edit', 'compare',
     # ipfp
     'ipfp',
     # example
-    'get_example_filepath', 'load_example_data',
+    'get_example_filepath', 'load_example_data', 'EXAMPLE_EXCEL_TEMPLATES_DIR',
 ]
 
 

larray/example.py

@@ -2,12 +2,18 @@
 import larray as la
 
 
-EXAMPLE_FILES_DIR = os.path.dirname(__file__) + '/tests/data/'
+_TEST_DIR = os.path.join(os.path.dirname(__file__), 'tests')
+
+EXAMPLE_FILES_DIR = os.path.join(_TEST_DIR, 'data')
+# TODO : replace 'demography.h5' by 'population_session.h5' and remove 'demo' ?
 AVAILABLE_EXAMPLE_DATA = {
+    'demo': os.path.join(EXAMPLE_FILES_DIR, 'population_session.h5'),
     'demography': os.path.join(EXAMPLE_FILES_DIR, 'demography.h5')
 }
 AVAILABLE_EXAMPLE_FILES = os.listdir(EXAMPLE_FILES_DIR)
 
+EXAMPLE_EXCEL_TEMPLATES_DIR = os.path.join(_TEST_DIR, 'excel_template')
+
 
 def get_example_filepath(fname):
     """Return absolute path to an example file if exist.