Metadata-Version: 1.1
Name: gspread-formatting
Version: 0.0.1
Summary: Apply cell formatting to gspread worksheets
Home-page: https://github.com/robin900/gspread-formatting
Author: Robin Thomas
Author-email: rthomas900@gmail.com
License: MIT
Description: gspread-formatting
        ------------------
        
        This package provides complete support of basic cell formatting for Google spreadsheets
        to the popular ``gspread`` package.
        
        Basic formatting of a range of cells in a worksheet is offered by the ``format_cell_range`` function . 
        All basic formatting components of the v4 Sheets API's ``CellFormat`` are present as classes 
        in the ``gspread_formatting`` module, available both by ``InitialCaps`` names and ``camelCase`` names: 
        for example, the background color class is ``BackgroundColor`` but is also available as 
        ``backgroundColor``, while the color class is ``Color`` but available also as ``color``. 
        Attributes of formatting components are best specified as keyword arguments using ``camelCase`` 
        naming, e.g. ``backgroundColor=...``. Complex formats may be composed easily, by nesting the calls to the classes.  
        
        See `the CellFormat page of the Sheets API documentation <https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#CellFormat>`_
        to learn more about each formatting component.::
        
                from gspread_formatting import *
        
                fmt = cellFormat(
                    backgroundColor=color(1, 0.9, 0.9),
                    textFormat=textFormat(bold=True, foregroundColor=color(1, 0, 1)),
                    horizontalAlignment='CENTER'
                    )
        
                format_cell_range(worksheet, 'A1:J1', fmt)
        
        ``CellFormat`` objects are comparable with ``==`` and ``!=``, and are mutable at all times; 
        they can be safely copied with ``copy.deepcopy``. ``CellFormat`` objects can be combined
        into a new ``CellFormat`` object using the ``add`` method (or ``+`` operator). ``CellFormat`` objects also offer 
        ``difference`` and ``intersection`` methods, as well as the corresponding
        operators ``-`` (for difference) and ``&`` (for intersection).::
        
                >>> default_format = CellFormat(backgroundColor=color(1,1,1), textFormat=textFormat(bold=True))
                >>> user_format = CellFormat(textFormat=textFormat(italic=True))
                >>> effective_format = default_format + user_format
                >>> effective_format
                CellFormat(backgroundColor=color(1,1,1), textFormat=textFormat(bold=True, italic=True))
                >>> effective_format - user_format 
                CellFormat(backgroundColor=color(1,1,1), textFormat=textFormat(bold=True))
                >>> effective_format - user_format == default_format
                True
        
        The spreadsheet's own default format, as a CellFormat object, is available via ``get_default_format(spreadsheet)``.
        ``get_effective_format(worksheet, label)`` and ``get_user_entered_format(worksheet, label)`` also will return
        for any provided cell label either a CellFormat object (if any formatting is present) or None.
        
        Installation
        ------------
        
        Requirements
        ~~~~~~~~~~~~
        
        * Python 2.6+ or Python 3+
        * gspread >= 3.0.0
        
        From PyPI
        ~~~~~~~~~
        
        ::
        
            pip install gspread-formatting
        
        From GitHub
        ~~~~~~~~~~~
        
        ::
        
            git clone https://github.com/robin900/gspread-formatting.git
            cd gspread-formatting
            python setup.py install
        
        
Keywords: spreadsheets,google-spreadsheets,formatting,cell-format
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
