Merge pull request #241 from best-practice-and-impact/dev

Updates for v1.2.0

Author: sarahcollyer

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.8]
+        python-version: ['3.11']
 
     steps:
     - uses: actions/checkout@v2
@@ -38,7 +38,7 @@ jobs:
       if: github.repository == 'best-practice-impact/gptables'
       uses: codecov/codecov-action@v3
       with:
-        name: gptables-pytests-py3.8
+        name: gptables-pytests-py3.11
         flags: pytests
         file: ./coverage.xml
         fail_ci_if_error: true
@@ -49,7 +49,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+
 
     steps:
     - uses: actions/checkout@v2
@@ -71,7 +72,8 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+
 
     steps:
     - uses: actions/checkout@v2
@@ -99,10 +101,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.7
+    - name: Set up Python 3.11
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: '3.11'
     - uses: actions/cache@v2
       with:
         path: ~\AppData\Local\pip\Cache
@@ -126,10 +128,10 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@v2
-      - name: Set up Python 3.7
+      - name: Set up Python 3.11
         uses: actions/setup-python@v1
         with:
-          python-version: 3.7
+          python-version: '3.11'
       - name: Build package
         run: |
           pip install wheel

.gitignore

@@ -5,4 +5,5 @@ env/
 *.pyc
 *~lock*
 docs/build/**
-gptables/examples/*.xlsx
+gptables/examples/*.xlsx
+.vscode/

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "gptables"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

README.rst

@@ -50,3 +50,6 @@ machine-readable CSV-W files.
 4. Optionally upload a ``notes_table`` with information about any notes.
 
 5. You ``write_workbook`` to win.
+
+
+**Note**: This package is not intending to create perfectly accessible spreadsheets but will help with the bulk of the work needed. Users of this packages should refer back to the `main spreadsheet guidance <https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/>`_ or the `spreadsheet accessibility checklist <https://analysisfunction.civilservice.gov.uk/policy-store/making-spreadsheets-accessible-a-brief-checklist-of-the-basics/>`_ after using it to make sure nothing has been missed. Please email `[email protected] <mailto:[email protected]>`_ if you use the package so we can monitor use and the outputs produced.

docs/source/changelog.rst

@@ -19,6 +19,33 @@ Unreleased
 Released (PyPI)
 ===============
 
+v1.2.0
+------
+:Date: 2024-12-05
+
+**Added**
+
+* Column width customisation to cover sheet
+* Incorporated rich text functionaliy into the cover page by using List[dict, str] to format text in the intro, about, and contact sections.
+* Rich text format lists can now be of length 2.
+* gptables now supports python 3.11
+* Official disclaimer included at the bottom of the README and PyPI index
+* pyproject.toml is now used to manage the packaging
+* Bugfix to allow writing of tables containing only integers
+* New examples to more simply explain things to new users
+* Update documentation for additional formatting
+
+**Removed**
+
+* CI for Python 3.6 on Linux, as no longer supported by GitHub action ``setup-python``
+* Dataclasses as a dependency due to no longer supporting Python 3.6
+* setup.py as this has been replaced by the more modern pyproject.toml
+
+**Changed**
+
+* Default theme now includes cover sheet text wrapping set to True
+
+
 v1.1.0
 ------
 :Date: 2022-07-27

docs/source/doc.gptable.rst

@@ -69,7 +69,7 @@ formatting of that element specified in the :class:`~.core.theme.Theme`.
 
 .. _`XlsxWriter format properties`: https://xlsxwriter.readthedocs.io/format.html#format-methods-and-format-properties
 
-``["It is ", {"bold": True}, "inevitable"]`` would give you "It is *inevitable*".
+``["It is ", {"bold": True}, "inevitable"]`` would give you "It is **inevitable**".
 
 See this in practice under :ref:`Example Usage`.
 
@@ -135,6 +135,179 @@ This ``additional_formatting`` parameter is best demonstrated by example:
          }
    ]
 
+Formatting methods
+^^^^^
+
+The following tables show the Excel format categories, along with an example demonstrating the syntax required
+for use in gptables. Some formatting methods use indexing to map to Excel's built-in formats. This information 
+can be found in the applicable sections below.
+
+^^^^
+Font formatting
+^^^^
+
+This table demonstrates the font formatting methods available. You can find all options
+for `underline styles in the XlsxWriter documentation`_.
+
+.. _`underline styles in the XlsxWriter documentation`: https://xlsxwriter.readthedocs.io/format.html#format-set-underline
+
+.. list-table::
+    :header-rows: 1
+    :widths: 19 30
+    :align: left
+
+    * - Description
+      - Example usage
+    * - Font type
+      - {"font_name": "Arial"}
+    * - Font size
+      - {"font_size": 30}
+    * - Font colour
+      - {"font_color": "red"}
+    * - Bold
+      - {"bold": True}
+    * - Italic
+      - {"italic": True}
+    * - Underline
+      - {"underline": 1}
+    * -  Strikeout
+      - {"font_strikeout": True}
+    * - Super/Subscript
+      - | {"font_script": 1} # Superscript
+        | {"font_script": 2} # Subscript
+..  
+^^^^^^
+Number formatting
+^^^^^^
+
+This table demonstrates how to set the numeric format using indexing and string arguments. You can find all 
+options for `numeric formats in the XlsxWriter documentation`_.
+
+.. _`numeric formats in the XlsxWriter documentation`: https://xlsxwriter.readthedocs.io/format.html#format-set-num-format
+
+.. list-table::
+    :header-rows: 1
+    :widths: 19 30
+    :align: left
+
+    * - Description
+      - Example usage
+    * - Numeric format
+      - | {"num_format": 1} # Format index 
+        | {"num_format": "d mmm yyyy"} # Format string
+.. 
+
+^^^^^^^^^^^
+Protection formatting
+^^^^^^^^^^^
+
+This table demonstrates the protection methods available.
+
+.. list-table::
+    :header-rows: 1
+    :widths: 19 30
+    :align: left
+
+    * - Description
+      - Example usage
+    * - Lock cells
+      - {"locked": True}
+    * - Hide formulas
+      - {"hidden": True}
+.. 
+
+^^^^^^^^^^^^
+Alignment formatting
+^^^^^^^^^^^^
+
+This table demonstrates the alignment formatting options available. You can find all options for 
+`horizontal and vertical alignment in the XlsxWriter documentation`_.
+
+.. _`horizontal and vertical alignment in the XlsxWriter documentation`: https://xlsxwriter.readthedocs.io/format.html#format-set-align
+
+.. list-table::
+    :header-rows: 1
+    :widths: 19 30
+    :align: left
+
+    * - Description
+      - Example usage
+    * - Horizontal align
+      - {"align": "center"}
+    * - Vertical align
+      - {"align": "vcenter"}
+    * - Rotation
+      - {"rotation": 30}
+    * - Text wrap
+      - {"text_wrap": True}
+    * - Center across
+      - {"set_center_across": True}
+    * - Indentation
+      - {"indentation":2}
+    * - Shrink to fit
+      - {"shrink": True}
+.. 
+
+^^^^^^^^^^^^^^^^
+Pattern formatting
+^^^^^^^^^^^^^^^^
+
+This table demonstrates the pattern formatting options available.
+
+.. list-table::
+    :header-rows: 1
+    :widths: 19 30
+    :align: left
+
+    * - Description
+      - Example usage  
+    * - Cell pattern
+      - {"pattern": 1}
+    * - Background colour
+      - {"bg_color": "white"}
+    * - Foreground colour
+      - {"fg_color": "white"}
+.. 
+
+^^^^^^^^^^^^^^^^^^
+Border formatting
+^^^^^^^^^^^^^^^^^^
+
+This table demonstrates the border formatting options available. You can find all options 
+for `border styles in the XlsxWriter documentation`_.
+
+.. _`border styles in the XlsxWriter documentation`: https://xlsxwriter.readthedocs.io/format.html#format-set-border
+
+.. list-table::
+    :header-rows: 1
+    :widths: 19 30
+    :align: left
+
+    * - Description
+      - Example usage
+    * - Cell border 
+      - {"border": 1}
+    * - Bottom border
+      - {"bottom": 1}
+    * - Top border
+      - {"top": 1}
+    * - Left border
+      - {"left": 1} 
+    * - Right border
+      - {"right": 1}
+    * - Border colour
+      - {"border_color": "red"}
+    * - Bottom colour
+      - {"bottom_color":"#FF0000"}
+    * - Top colour
+      - {"top_color": "red"}
+    * - Left colour
+      - {"left_color": "#FF0000"}
+    * - Right colour
+      - {"right_color": "red"}
+
+..
+
 For any formatting beyond this, if the package should support it then please raise an issue
 or create a pull request. Otherwise, you will need to modify the underlying
 :class:`~.core.wrappers.GPWorkbook` or :class:`~.core.wrappers.GPWorksheet` objects

docs/source/index.rst

@@ -56,6 +56,9 @@ machine-readable CSV-W files.
 5. You :func:`~.core.api.write_workbook` to win.
 
 
+**Note**: This package is not intending to create perfectly accessible spreadsheets but will help with the bulk of the work needed. Users of this packages should refer back to the `main spreadsheet guidance <https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/>`_ or the `spreadsheet accessibility checklist <https://analysisfunction.civilservice.gov.uk/policy-store/making-spreadsheets-accessible-a-brief-checklist-of-the-basics/>`_ after using it to make sure nothing has been missed. Please email `[email protected] <mailto:[email protected]>`_ if you use the package so we can monitor use and the outputs produced.
+
+
 .. toctree::
    :maxdepth: 2
    :hidden: