Metadata-Version: 2.1
Name: gptables
Version: 0.3.3
Summary: Simplifying good practice in statistical tables.
Home-page: https://best-practice-and-impact.github.io/gptables/
Author: David Foster
Author-email: david.foster@ons.gov.uk
License: MIT license
Keywords: reproducible tables excel xlsxwriter reproducible-analytical-pipelines
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: pandas (>=0.25.3)
Requires-Dist: xlrd (>=1.2.0)
Requires-Dist: XlsxWriter (>=1.2.6)
Requires-Dist: pyyaml (>=3.12)
Requires-Dist: dataclasses
Provides-Extra: docs
Requires-Dist: sphinx (>=2) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: pandas (>=0.25.3) ; extra == 'docs'
Requires-Dist: xlrd (>=1.2.0) ; extra == 'docs'
Requires-Dist: XlsxWriter (>=1.2.6) ; extra == 'docs'
Requires-Dist: pyyaml (>=3.12) ; extra == 'docs'
Requires-Dist: dataclasses ; extra == 'docs'
Provides-Extra: testing
Requires-Dist: coverage ; extra == 'testing'
Requires-Dist: pytest (<4,>=3.6) ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: sphinx (>=2) ; extra == 'testing'
Requires-Dist: sphinx-rtd-theme ; extra == 'testing'
Requires-Dist: pandas (>=0.25.3) ; extra == 'testing'
Requires-Dist: xlrd (>=1.2.0) ; extra == 'testing'
Requires-Dist: XlsxWriter (>=1.2.6) ; extra == 'testing'
Requires-Dist: pyyaml (>=3.12) ; extra == 'testing'
Requires-Dist: dataclasses ; extra == 'testing'

Good Practice Tables (gptables)
===============================

.. image:: https://travis-ci.org/best-practice-and-impact/gptables.svg?branch=master
    :target: https://travis-ci.org/best-practice-and-impact/gptables
    :alt: Travis build status

.. image:: https://badge.fury.io/py/gptables.svg
    :target: https://badge.fury.io/py/gptables
    :alt: PyPI release


``gptables`` is an opinionated python package for spreadsheet production.
It produces ``.xlsx`` files from your ``pandas`` dataframes or using
``reticulate`` in R. You define the mapping from your data to elements of the
table. It does the rest.

``gptables`` uses the official `guidance on good practice spreadsheets`_.
It advocates a strong adherence to the guidance by restricting the range of operations possible.
The default theme ``gptheme`` should accommodate most use cases.
However, the ``Theme`` object allows development of custom themes, where other formatting is required.

``gptables`` is developed and maintained by the `Best Practice and Impact`_
division of the Office for National Statistics, UK.

.. _`guidance on good practice spreadsheets`: https://gss.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/

.. _`Best Practice and Impact`: https://gss.civilservice.gov.uk/about-us/support-for-the-gss/


4 Simple Steps
--------------

1. You map your data to the elements of a ``GPTable``.

2. You can define the format of each element with a custom ``Theme``, or simply use the default - gptheme.

3. Optionally design a ``Cover`` page to provide information that relates to all of the tables in your Workbook.

4. You ``write_workbook`` to win.


