ethanwillis / webgrid

WebGrid

Introduction

WebGrid is a datagrid library for Flask and other Python web frameworks designed to work with SQLAlchemy ORM entities.

Based on the configured grid, it will output an HTML table with sorting, filtering, and paging.

It also will export the grid to Excel.

For now, if you are interested in using it, you will need to see the source code and tests therein for example usage.

Questions & Comments

Please visit: http://groups.google.com/group/blazelibs

Running the Tests

Make sure to include the --nologcapture flag to nosetests or else you will get failures when testing the logging features.

Current Status

Currently beta quality.

Translations

Helpful links

• https://www.gnu.org/software/gettext/manual/html_node/Mark-Keywords.html
• https://www.gnu.org/software/gettext/manual/html_node/Preparing-Strings.html

Message management

The setup.cfg file is configured to handle the standard message extraction commands.

To manage the messages in the webgrid_ta test application:

• extract_messages

  setup.py extract_messages --input-dirs=webgrid_ta --mapping-file=webgrid_ta/i18n/babel.cfg --output-file=webgrid_ta/i18n/webgrid_ta.pot
  

• init_catalog

  setup.py init_catalog --domain=webgrid_ta --input-file=webgrid_ta/i18n/webgrid_ta.pot --output-dir=webgrid_ta/i18n --locale=es
  

• update_catalog

  setup.py update_catalog --domain=webgrid_ta --input-file=webgrid_ta/i18n/webgrid_ta.pot --output-dir=webgrid_ta/i18n
  

• compile_catalog

  setup.py compile_catalog --domain=webgrid_ta --directory=webgrid_ta/i18n
  

Upgrading

Upgrading to v0.1.38

The i18n support added in v0.1.38 introduces a slight change which could affect existing installations, related to the handling of "table totals" labels.

In versions prior to v0.1.38, the word 'Totals' (ie, "Page Totals" or "Grand Totals") was added by the renderers.HTML.table_totals method. Starting in v0.1.38, the word 'Totals' is added individually in the methods which call table_totals (currently renderers.HTML.table_pagetotals and renderers.HTML.table_grandtotals).

Installations which customize any of the renderers.HTML.table_totals, renderers.HTML.table_pagetotals, or renderers.HTML.table_grandtotals should review the changes to ensure proper functionality.