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](

## 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_UI`: Choose the UI displaying previews. You can choose between csvapi-front and dataexplorer. Default value is csvapi-front

  • `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 50

## Development

### JS dependencies

Install JS dependencies with:

`shell npm install `

Then you can package these assets with:

`shell inv assets `

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

### 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

## 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.

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page