222 gridlines on selected sheets (#228)

* Add gridlines to all sheets except cover

* Add options for user to show or hide gridlines

* Make gridlines off by default

* Apply suggested changes and add gridlines to expected workbook in test api

* Fix numbering on gridlines

* Update expected workbook

Author: ldavies99

gptables/core/api.py

@@ -16,6 +16,8 @@ def produce_workbook(
         notesheet_label = "Notes",
         notesheet_options = {},
         auto_width = True,
+        gridlines = "hide_all",
+        cover_gridlines = False
         ):
     """
     Produces a GPWorkbook, ready to be written to the specified `.xlsx` file
@@ -50,6 +52,13 @@ def produce_workbook(
     auto_width : bool, optional
         indicate if column widths should be automatically determined. True
         by default.
+    gridlines : string, optional
+        option to hide or show gridlines on worksheets. "show_all" - don't 
+        hide gridlines, "hide_printed" - hide printed gridlines only, or 
+        "hide_all" - hide screen and printed gridlines.
+    cover_gridlines : bool, optional
+        indication if gridlines should apply to the cover worksheet. False 
+        by default.
         
     Returns
     -------
@@ -64,7 +73,10 @@ def produce_workbook(
         wb.set_theme(theme)
 
     if cover is not None:
-        ws = wb.add_worksheet(cover.cover_label)
+        if cover_gridlines:
+            ws = wb.add_worksheet(cover.cover_label, gridlines=gridlines)
+        else:
+            ws = wb.add_worksheet(cover.cover_label, gridlines="hide_all")
         ws.write_cover(cover)
 
     contentsheet = {}
@@ -90,7 +102,7 @@ def produce_workbook(
 
     sheets = {**contentsheet, **notesheet, **sheets}
     for label, gptable in sheets.items():
-        ws = wb.add_worksheet(label)
+        ws = wb.add_worksheet(label, gridlines=gridlines)
         ws.write_gptable(gptable, auto_width, wb._annotations)
 
     return wb
@@ -108,6 +120,8 @@ def write_workbook(
         notesheet_label = "Notes",
         notesheet_options = {},
         auto_width = True,
+        gridlines = "hide_all",
+        cover_gridlines = False
         ):
 
     """
@@ -149,6 +163,13 @@ def write_workbook(
     auto_width : bool, optional
         indicate if column widths should be automatically determined. True by
         default.
+    gridlines : string, optional
+        option to hide or show gridlines on worksheets. "show_all" - don't 
+        hide gridlines, "hide_printed" - hide printed gridlines only, or 
+        "hide_all" - hide screen and printed gridlines.
+    cover_gridlines : bool, optional
+        indication if gridlines should apply to the cover worksheet. False 
+        by default.
     contentsheet : str
         alias for contentsheet_label, deprecated in v1.1.0
 
@@ -169,6 +190,8 @@ def write_workbook(
         notes_table,
         notesheet_label,
         notesheet_options,
-        auto_width
+        auto_width,
+        gridlines,
+        cover_gridlines
         )
     wb.close()

gptables/core/wrappers.py

@@ -1052,14 +1052,18 @@ def __init__(self, filename=None, options={}):
         # Set default theme
         self.set_theme(gptheme)
 
-    def add_worksheet(self, name=None):
+    def add_worksheet(self, name=None, gridlines="hide_all"):
         """
         Overwrite add_worksheet() to create a GPWorksheet object.
         
         Parameters
         ----------
         name : str (optional)
             name of the the worksheet to be created
+        gridlines : string, optional
+        option to hide or show gridlines on worksheets. "show_all" - don't 
+        hide gridlines, "hide_printed" - hide printed gridlines only, or 
+        "hide_all" - hide screen and printed gridlines.
         
         Returns
         -------
@@ -1069,7 +1073,14 @@ def add_worksheet(self, name=None):
         worksheet = super(GPWorkbook, self).add_worksheet(name, GPWorksheet)
         worksheet.theme = self.theme
         worksheet._workbook = self  # Create reference to wb, for formatting
-        worksheet.hide_gridlines(2)
+        
+        worksheet.hide_gridlines({
+            "show_all": 0,
+            "hide_printed": 1,
+            "hide_all": 2
+            }[gridlines]
+        )
+        
         return worksheet
 
 

gptables/test/expected_workbook.xlsx

@@ -58,6 +58,8 @@ def generate_gpworkbook(output_path):
             notes_table=notes_table,
             notesheet_label="Notes table",
             notesheet_options={"title": "Table with notes"},
+            gridlines="show_all",
+            cover_gridlines=False
         )
 
     return generate_gpworkbook