Skip to main content

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

Project description

Tabular Preview

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


Install the plugin package in you udata environement:

pip install udata-tabular-preview

Then activate it in your udata.cfg:

PLUGINS = ['tabular']


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_MAX_SIZE: Max allowed file size in bytes if defined. Default value is None
  • TABULAR_PAGE_SIZE: fetched data page size. Default to 5


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


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

inv test


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

inv qa


4.0.0 (2024-05-06)

  • :warning: Plug udata-tabular-preview to tabular api and decomission of csvapi #33
  • Migrate to Python 3.11 following udata dependencies upgrade #35
  • Don't show preview if parsing has failed #36
  • Display the latest date of the preview #37
  • Set long description content type to markdown in dist #39

4.0.0 (2024-03-22)

  • Connect preview with hydra and remove csvapi + styles for preview #32 Current (in progress)
  • Use pagination from package @etalab/ #34

3.1.0 (2024-01-23)

  • Use either of analysis or header check mime #32

3.0.4 (2024-01-09)

  • Update mongoDB in CI #25
  • Use analysis extras on top of check:headers #30

3.0.3 (2023-03-07)

  • Specify version in static #27
  • Add python translations logic #26

3.0.2 (2023-03-02)

  • Add data structure component and explore button for hook dataset.display.explore-button #19

3.0.1 (2023-02-06)

  • Add sort to exploration preview component #20
  • Fix setuptools version used in CI #23
  • Add pagination to exploration preview component #21

3.0.0 (2023-01-18)

  • :warning: Breaking change Change preview behaviour #14
    • remove preview route
    • add exploration preview Vue component
    • add explorable_ressources metadata
  • Replace mongo legacy image in CI #13
  • Update json5 to fix CVE-2022-46175 #16

2.0.3 (2022-07-11)

  • Remove legacy manifest logic and dataexplorer integration #12

2.0.2 (2020-10-16)

  • Add a setting for SUPPORTED_MIME_TYPES #9

2.0.1 (2020-06-17)

  • Use extras attributes to enable preview #8

2.0.0 (2020-03-11)

  • Migrate to Python3 #5

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-4.0.0-py2.py3-none-any.whl (246.4 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