Good Practice Tables (gptables)
===============================
.. image:: https://github.com/best-practice-and-impact/gptables/workflows/continuous-integration/badge.svg
:target: https://github.com/best-practice-and-impact/gptables/actions
:alt: Actions build status
.. image:: https://readthedocs.org/projects/gptables/badge/?version=latest
:target: https://gptables.readthedocs.io/en/latest/?badge=latest
:alt: Documentation 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 `Analysis Function`_. It can be
installed from `PyPI`_ or `GitHub`_. The source code is maintained on GitHub.
Users may also be interested in `a11ytables`_, an R native equivalent to
``gptables``, and `csvcubed`_, a package for turning data and metadata into
machine-readable CSV-W files.
.. _`guidance on good practice spreadsheets`: https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/
.. _`Analysis Function`: https://analysisfunction.civilservice.gov.uk/
.. _`PyPI`: https://pypi.org/project/gptables/
.. _`GitHub`: https://github.com/best-practice-and-impact/gptables
.. _`a11ytables`: https://co-analysis.github.io/a11ytables/index.html
.. _`csvcubed`: https://gss-cogs.github.io/csvcubed-docs/external/
5 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. 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 `Analysis.Function@ons.gov.uk <mailto:Analysis.Function@ons.gov.uk>`_ if you use the package so we can monitor use and the outputs produced.
Raw data
{
"_id": null,
"home_page": null,
"name": "gptables",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Analysis Standards and Pipelines <ASAP@ons.gov.uk>",
"keywords": "reproducible, tables, excel, xlsxwriter, reproducible-analytical-pipelines",
"author": null,
"author_email": "Analysis Standards and Pipelines <ASAP@ons.gov.uk>",
"download_url": "https://files.pythonhosted.org/packages/6e/e4/9c211e084ddc8c19d420861c3f9714a208fa7213a8536e783171d2b6958e/gptables-1.2.0.tar.gz",
"platform": null,
"description": "Good Practice Tables (gptables)\n===============================\n\n.. image:: https://github.com/best-practice-and-impact/gptables/workflows/continuous-integration/badge.svg\n :target: https://github.com/best-practice-and-impact/gptables/actions\n :alt: Actions build status\n \n.. image:: https://readthedocs.org/projects/gptables/badge/?version=latest\n :target: https://gptables.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://badge.fury.io/py/gptables.svg\n :target: https://badge.fury.io/py/gptables\n :alt: PyPI release\n\n\n``gptables`` is an opinionated python package for spreadsheet production.\nIt produces ``.xlsx`` files from your ``pandas`` dataframes or using\n``reticulate`` in R. You define the mapping from your data to elements of the\ntable. It does the rest.\n\n``gptables`` uses the official `guidance on good practice spreadsheets`_.\nIt advocates a strong adherence to the guidance by restricting the range of operations possible.\nThe default theme ``gptheme`` should accommodate most use cases.\nHowever, the ``Theme`` object allows development of custom themes, where other formatting is required.\n\n``gptables`` is developed and maintained by the `Analysis Function`_. It can be\ninstalled from `PyPI`_ or `GitHub`_. The source code is maintained on GitHub.\nUsers may also be interested in `a11ytables`_, an R native equivalent to\n``gptables``, and `csvcubed`_, a package for turning data and metadata into\nmachine-readable CSV-W files.\n\n.. _`guidance on good practice spreadsheets`: https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/\n.. _`Analysis Function`: https://analysisfunction.civilservice.gov.uk/\n.. _`PyPI`: https://pypi.org/project/gptables/\n.. _`GitHub`: https://github.com/best-practice-and-impact/gptables\n.. _`a11ytables`: https://co-analysis.github.io/a11ytables/index.html\n.. _`csvcubed`: https://gss-cogs.github.io/csvcubed-docs/external/\n\n\n5 Simple Steps\n--------------\n\n1. You map your data to the elements of a ``GPTable``.\n\n2. You can define the format of each element with a custom ``Theme``, or simply use the default - gptheme.\n\n3. Optionally design a ``Cover`` page to provide information that relates to all of the tables in your Workbook.\n\n4. Optionally upload a ``notes_table`` with information about any notes.\n\n5. You ``write_workbook`` to win.\n\n\n**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 `Analysis.Function@ons.gov.uk <mailto:Analysis.Function@ons.gov.uk>`_ if you use the package so we can monitor use and the outputs produced.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Simplifying good practice in statistical tables.",
"version": "1.2.0",
"project_urls": {
"Documentation": "https://gptables.readthedocs.io/en/latest/",
"Homepage": "https://github.com/best-practice-and-impact/gptables"
},
"split_keywords": [
"reproducible",
" tables",
" excel",
" xlsxwriter",
" reproducible-analytical-pipelines"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "313b3b9679c1a21cd4637664eb442e7396b5b212435ff40796431d9c449548c2",
"md5": "e241f6ea868a390739c353edbb7e293b",
"sha256": "eecfc58e01ca40bcb8711c2130af7532803f365ebaa97358e6c9b20a07cbe843"
},
"downloads": -1,
"filename": "gptables-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e241f6ea868a390739c353edbb7e293b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 72408,
"upload_time": "2025-01-08T16:08:12",
"upload_time_iso_8601": "2025-01-08T16:08:12.128207Z",
"url": "https://files.pythonhosted.org/packages/31/3b/3b9679c1a21cd4637664eb442e7396b5b212435ff40796431d9c449548c2/gptables-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ee49c211e084ddc8c19d420861c3f9714a208fa7213a8536e783171d2b6958e",
"md5": "540bf15eca728cb09a8d1be134685a4b",
"sha256": "314c987db978ae89b700b96c15466a1877d459450049f83a9f01298f6a5b8e52"
},
"downloads": -1,
"filename": "gptables-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "540bf15eca728cb09a8d1be134685a4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 62425,
"upload_time": "2025-01-08T16:08:13",
"upload_time_iso_8601": "2025-01-08T16:08:13.876721Z",
"url": "https://files.pythonhosted.org/packages/6e/e4/9c211e084ddc8c19d420861c3f9714a208fa7213a8536e783171d2b6958e/gptables-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-08 16:08:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "best-practice-and-impact",
"github_project": "gptables",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "gptables"
}
JSON
