| Name | simple-parquet-viewer JSON |
| Version |
0.11.1
JSON |
| download |
| home_page | |
| Summary | A simple (and lightweight) visualization tool for Parquet files. |
| upload_time | 2023-05-09 15:46:51 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
gui
parquet
viewer
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Simple Parquet Viewer
A simple (and lightweight) visualization tool for Parquet files.
## Installation
In order to install it, you just have to run the following command in the shell:
```sh
pip install simple-parquet-viewer
```
Alternatively you can install the distribution package available in the [releases page](https://github.com/mauromascarenhas/simple-parquet-viewer/releases).
## Usage
To open the app, it is just necessary to call it from the shell (notice that *path_to_file* arg is optional):
```sh
spv [path_to_file]
```
### Creating shortcut (Windows only)
In order to use the shortcut creation utility, the [pywin32](https://pypi.org/project/pywin32/) package must be already installed. Otherwise, you will have to install it by running either `pip install pywin32` or `pip install simple-parquet-viewer[windows]`.
Since this is a GUI application, it would be easier to start it from a shortcut rather than the command line. Therefore, in order to make the shortcut creation easier, this application provides a convenience script for that purpose. By running following command, for instance, a shortcut for "*Simple Parquet Viewer*" must be created in the Start Menu:
```cmd
spv-shortcut
```
**NB.:** Icons generated using this utility are not automatically removed when this package is uninstalled. Therefore, you must remove them manually afterwards.
#### Desktop shortcut
The `spv-shortcut` utility also supports a valid *`dir_path`* as first argument, allowing you to generate a shortcut in custom directories, such as "*Desktop*". The following example demonstrates how to create a desktop shortcut for this application:
```cmd
spv-shortcut %USERPROFILE%\Desktop
```
In PowerShell:
```powershell
spv-shortcut $env:USERPROFILE\Desktop
```
## Development
There are some utilities which have made the development of this application a bit easier:
- **Icon generation**: The application icons have been generated by using open source vectorized images, which can be found close to their "png/ico" versions at `./src/res/imgs/`;
- **i18n script**: This script makes creating and deploying translation files a bit easier by calling tools like *pylupdate*, *linguist* and *lrelease* under the hood;
- **package creation**: The distribution package of this library is build with [hatch](https://hatch.pypa.io/latest/) (check `pyproject.toml` file for specs).
### Generating icon
The usage of inkscape in order to create/modify application icons is strongly recommended, since it is free and open source (and anyone would be able to contribute), but any vectorized drawing tool can be used for this purpose.
In order to deploy the application icon, it was necessary to make use of *imagemagick* so as to convert the SVG file to a multi-sized icon. The following command has been used generate it:
```sh
magick convert ./src/res/imgs/app_icon.svg -define icon:auto-resize=256,128,48,32,16 -background none -fuzz 10% -transparent white ./src/res/imgs/app_icon.ico
```
### Translations
The usage of **i18n** script is quite straightforward: it is usually `python ./scripts/i18n.py <COMMAND> <LANG_CODE>`, where the command depends on the translation step:
- **generate**: Used to generate a new translation file or update the strings of an existing one;
- **edit**: Convenience method to open **Qt Linguist** (an editor for translation files);
- **release**: Used when the translation is ready for deployment (builds a compiled translation file).
**NB:** It is necessary to have *PyQt6* and *qt6_applications* so as to be able to run every command.
### Package generation
In order to build this package, it is just necessary to run the following command in the sell:
```sh
python -m build
```
Raw data
{
"_id": null,
"home_page": "",
"name": "simple-parquet-viewer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "GUI,Parquet,Viewer",
"author": "",
"author_email": "Mauro Mascarenhas de Ara\u00fajo <mauromascarenhas@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/c5/5b/7fd13622fe3bbad92624a593d601e657b171de71ed2d96157cd2ccb01f45/simple_parquet_viewer-0.11.1.tar.gz",
"platform": null,
"description": "# Simple Parquet Viewer\n\nA simple (and lightweight) visualization tool for Parquet files.\n\n## Installation\n\nIn order to install it, you just have to run the following command in the shell:\n\n```sh\npip install simple-parquet-viewer\n```\n\nAlternatively you can install the distribution package available in the [releases page](https://github.com/mauromascarenhas/simple-parquet-viewer/releases).\n\n## Usage\n\nTo open the app, it is just necessary to call it from the shell (notice that *path_to_file* arg is optional):\n\n```sh\nspv [path_to_file]\n```\n\n### Creating shortcut (Windows only)\n\nIn order to use the shortcut creation utility, the [pywin32](https://pypi.org/project/pywin32/) package must be already installed. Otherwise, you will have to install it by running either `pip install pywin32` or `pip install simple-parquet-viewer[windows]`.\n\nSince this is a GUI application, it would be easier to start it from a shortcut rather than the command line. Therefore, in order to make the shortcut creation easier, this application provides a convenience script for that purpose. By running following command, for instance, a shortcut for \"*Simple Parquet Viewer*\" must be created in the Start Menu:\n\n```cmd\nspv-shortcut\n```\n\n**NB.:** Icons generated using this utility are not automatically removed when this package is uninstalled. Therefore, you must remove them manually afterwards.\n\n#### Desktop shortcut\n\nThe `spv-shortcut` utility also supports a valid *`dir_path`* as first argument, allowing you to generate a shortcut in custom directories, such as \"*Desktop*\". The following example demonstrates how to create a desktop shortcut for this application:\n\n```cmd\nspv-shortcut %USERPROFILE%\\Desktop\n```\n\nIn PowerShell:\n\n```powershell\nspv-shortcut $env:USERPROFILE\\Desktop\n```\n\n## Development\n\nThere are some utilities which have made the development of this application a bit easier:\n\n- **Icon generation**: The application icons have been generated by using open source vectorized images, which can be found close to their \"png/ico\" versions at `./src/res/imgs/`;\n- **i18n script**: This script makes creating and deploying translation files a bit easier by calling tools like *pylupdate*, *linguist* and *lrelease* under the hood;\n- **package creation**: The distribution package of this library is build with [hatch](https://hatch.pypa.io/latest/) (check `pyproject.toml` file for specs).\n\n### Generating icon\n\nThe usage of inkscape in order to create/modify application icons is strongly recommended, since it is free and open source (and anyone would be able to contribute), but any vectorized drawing tool can be used for this purpose.\n\nIn order to deploy the application icon, it was necessary to make use of *imagemagick* so as to convert the SVG file to a multi-sized icon. The following command has been used generate it:\n\n```sh\nmagick convert ./src/res/imgs/app_icon.svg -define icon:auto-resize=256,128,48,32,16 -background none -fuzz 10% -transparent white ./src/res/imgs/app_icon.ico\n```\n\n### Translations\n\nThe usage of **i18n** script is quite straightforward: it is usually `python ./scripts/i18n.py <COMMAND> <LANG_CODE>`, where the command depends on the translation step:\n\n- **generate**: Used to generate a new translation file or update the strings of an existing one;\n- **edit**: Convenience method to open **Qt Linguist** (an editor for translation files);\n- **release**: Used when the translation is ready for deployment (builds a compiled translation file).\n\n**NB:** It is necessary to have *PyQt6* and *qt6_applications* so as to be able to run every command.\n\n### Package generation\n\nIn order to build this package, it is just necessary to run the following command in the sell:\n\n```sh\npython -m build\n```",
"bugtrack_url": null,
"license": "",
"summary": "A simple (and lightweight) visualization tool for Parquet files.",
"version": "0.11.1",
"project_urls": {
"Bug Tracker": "https://github.com/mauromascarenhas/simple-parquet-viewer/issues",
"Homepage": "https://github.com/mauromascarenhas/simple-parquet-viewer"
},
"split_keywords": [
"gui",
"parquet",
"viewer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfe356a701b6e2c6a85f88053c49bd8a2b757e76433812b45ecc7c197bc7e122",
"md5": "41922393afe2c7324738b37f7d11ee5f",
"sha256": "d5e3227d4372a4e4f3fd1dcc043a4d4b6e1985f959dc1354bfa2a09d4d155d92"
},
"downloads": -1,
"filename": "simple_parquet_viewer-0.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41922393afe2c7324738b37f7d11ee5f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 187928,
"upload_time": "2023-05-09T15:46:48",
"upload_time_iso_8601": "2023-05-09T15:46:48.835071Z",
"url": "https://files.pythonhosted.org/packages/df/e3/56a701b6e2c6a85f88053c49bd8a2b757e76433812b45ecc7c197bc7e122/simple_parquet_viewer-0.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c55b7fd13622fe3bbad92624a593d601e657b171de71ed2d96157cd2ccb01f45",
"md5": "df41ab604b90d07e6eaceb952584b1e7",
"sha256": "9406cc8afdaf0d205773f85469c10ca6006e0bfce3835ddd54d0c7a0329d26fc"
},
"downloads": -1,
"filename": "simple_parquet_viewer-0.11.1.tar.gz",
"has_sig": false,
"md5_digest": "df41ab604b90d07e6eaceb952584b1e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 174275,
"upload_time": "2023-05-09T15:46:51",
"upload_time_iso_8601": "2023-05-09T15:46:51.192570Z",
"url": "https://files.pythonhosted.org/packages/c5/5b/7fd13622fe3bbad92624a593d601e657b171de71ed2d96157cd2ccb01f45/simple_parquet_viewer-0.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-09 15:46:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mauromascarenhas",
"github_project": "simple-parquet-viewer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "simple-parquet-viewer"
}
