Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 1.78 KB

README.md

File metadata and controls

84 lines (53 loc) · 1.78 KB
Raw

Tabular Preview

A plugin to preview tabular files (CSV, Excel ...) using tabular-api

Usage

Install the plugin package in you udata environement:

pip install udata-tabular-preview

Then activate it in your udata.cfg:

PLUGINS = ['tabular']

Configuration

You can control this plugin behavior with the following udata.cfg parameters:

  • TABULAR_API_URL: The URL to your tabular-api instance (without trailing slash). ex: https://my.tabular.api
  • TABULAR_EXPLORE_URL: The URL to your explore instance (without trailing slash). ex: https://my.explore
  • TABULAR_ALLOW_REMOTE: Whether or not to allow remote resources preview. Default value is True
  • TABULAR_PAGE_SIZE: fetched data page size. Default to 5

Development

JS dependencies

Install JS dependencies with:

npm install

Then you can package these assets with:

inv assets-watch

(You might need to relaunch these commands when you pull upstream changes).

You can build a production-ready version of JS and CSS assets with:

inv assets-build

You should extract the vue-i18n language files after modifying this plugin with :

inv i18n

Python dependencies

Assuming you are in an active virtualenv with udata installed and in the current project cloned repository directory, install all dependencies using:

pip install -e requirements/develop.pip

(You might need to relaunch this command when you pull upstream changes).

Testing

Tests are located into the tests folder and be run with:

inv test

Quality

Code must pass Flake 8 validation and README should be compatible with PyPI. You can check both with:

inv qa