udata-tabular-preview 3.0.1

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

# Tabular Preview

A plugin to preview tabular files (CSV, Excel, …) using [csvapi](https://github.com/opendatateam/csvapi)

## Usage

Install the plugin package in you udata environement:

`bash pip install udata-tabular-preview `

Then activate it in your udata.cfg:

`python PLUGINS = ['tabular'] `

## Configuration

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

• `TABULAR_CSVAPI_URL`: The URL to your csvapi instance (without trailing slash). ex: https://my.csvapi

• `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_MAX_SIZE`: Max allowed file size in bytes if defined. Default value is None

• `TABULAR_PAGE_SIZE`: fetched data page size. Default to 5

## Development

### JS dependencies

Install JS dependencies with:

`shell npm install `

Then you can package these assets with:

`shell 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:

`shell inv assets-build `

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

`shell 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:

`shell 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:

`shell inv test `

### Quality

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

`shell inv qa `

# Changelog

## 3.0.1 (2023-02-06)

• Add sort to exploration preview component [#20](https://github.com/opendatateam/udata-tabular-preview/pull/20)

• Fix setuptools version used in CI [#23](https://github.com/opendatateam/udata-tabular-preview/pull/23)

• Add pagination to exploration preview component [#21](https://github.com/opendatateam/udata-tabular-preview/pull/21)

## 3.0.0 (2023-01-18)

• warning:

  Breaking change Change preview behaviour [#14](https://github.com/opendatateam/udata-tabular-preview/pull/14) - remove preview route - add exploration preview Vue component - add explorable_ressources metadata

• Replace mongo legacy image in CI [#13](https://github.com/opendatateam/udata-tabular-preview/pull/13)

• Update json5 to fix CVE-2022-46175 [#16](https://github.com/opendatateam/udata-tabular-preview/pull/16)

## 2.0.3 (2022-07-11)

• Remove legacy manifest logic and dataexplorer integration [#12](https://github.com/opendatateam/udata-tabular-preview/pull/12)

## 2.0.2 (2020-10-16)

• Add a setting for SUPPORTED_MIME_TYPES [#9](https://github.com/opendatateam/udata-tabular-preview/pull/9)

## 2.0.1 (2020-06-17)

• Use extras attributes to enable preview [#8](https://github.com/opendatateam/udata-tabular-preview/pull/8)

## 2.0.0 (2020-03-11)

• Migrate to Python3 [#5](https://github.com/opendatateam/udata-tabular-preview/pull/5)

## 1.0.0 (2018-10-02)

Initial release