Skip to main content

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

Project description

# 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.2 (2023-03-02)

## 3.0.1 (2023-02-06)

## 3.0.0 (2023-01-18)

## 2.0.3 (2022-07-11)

## 2.0.2 (2020-10-16)

## 2.0.1 (2020-06-17)

## 2.0.0 (2020-03-11)

## 1.0.0 (2018-10-02)

Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

udata_tabular_preview-3.0.2-py2.py3-none-any.whl (49.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page