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.1.0 (2024-01-23)
Use either of analysis or header check mime [#32](https://github.com/opendatateam/udata-tabular-preview/pull/32)
## 3.0.4 (2024-01-09)
Update mongoDB in CI [#25](https://github.com/opendatateam/udata-tabular-preview/pull/25)
Use analysis extras on top of check:headers [#30](https://github.com/opendatateam/udata-tabular-preview/pull/30)
## 3.0.3 (2023-03-07)
Specify version in static [#27](https://github.com/opendatateam/udata-tabular-preview/pull/27)
Add python translations logic [#26](https://github.com/opendatateam/udata-tabular-preview/pull/26)
## 3.0.2 (2023-03-02)
Add data structure component and explore button for hook dataset.display.explore-button [#19](https://github.com/opendatateam/udata-tabular-preview/pull/19)
## 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for udata_tabular_preview-3.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dac4aa1932a5af63ddcd548b9a2d447d14f7b03a993cc44f6873e57646bd1db8 |
|
MD5 | 87cab83c3d330874f3c20eed2d5dad38 |
|
BLAKE2b-256 | e701544fb3554bc5349b970bd815c6708e8adaadccda46585819a6eee0de8378 |