| Name | qrImageIndexerGUI JSON |
| Version |
0.3.3
JSON |
| download |
| home_page | |
| Summary | GUI interface for tool for indexing images with QR codes |
| upload_time | 2023-08-16 04:38:14 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2022 jonpecar Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
sorter
qrcode
photosorter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# qrCodeImageSorterGUI
GUI interface for the [qrCodeImageSorter](https://github.com/jonpecar/qrCodeImageSorter) repository. For detailed information on the philosophy
of the tool see the readme in this repository. This is a GUI interface for this underlying toolset.
## A Quick (but rough) Video Guide
https://user-images.githubusercontent.com/65805625/192924326-2560853a-2418-4b95-8806-40d787ae489c.mp4
## Installation
To install the tool, run the below command with any version of Python above 3.7:
```pip install qrImageIndexerGUI```
## Instructions
---
### Launch Window
---
To load the launch window, run the command:
```python -m qrImageIndexerGUI```
This will present the user with the following window:
From here you can open either the window for generating the QR codes or for sorting the resultant images.
### Generate QR Codes
---
This window allows the user to generate QR codes. It also provides a preview of what the output PDF will look like:
The available controls are listed below:
1. Save PDF generated based on the listed inputs to file;
2. Update sample PDF based on the listed inputs;
3. Toggle sorting of PDF for slicing or down the page;
4. Toggle generating QR codes for heading lines;
5. Toggle reapeating of parent headings on every line of the PDF;
6. Toggle inclusion of a prefix in the QR code;
7. Configure prefix to include;
8. Tab-delineated item input;
9. Sample PDF display.
The recommended settings are set by default. In most situations the user should just enter their own text in the
text entry field (8).
### Sort Images
---
This window allows the user to sort photos that have been taken with QR codes in them. The interface will look similar to the below.
Note that the provided screenshot is shown after having scanned a folder of images for demonstration. It will be blank prior to this:
The available controls are listed below:
1. Scan images from a selected directory. This will open a prompt asking the user to select a directory;
2. Save sorted images in a directory. This will save the images in the folder structure dictaged by the detected QR codes;
3. Progress bar to indicate image scanning progress;
4. Indicate whether QR codes have a prefix attached;
5. Specify QR code prefix if used;
6. Display images where QR codes are detected;
6.1. Path to specified image;
6.2. Thumbnail of image;
6.3. Path detected in QR code.
#### Not Shown: New Feature - Quick Sort
There is now a quick sort button. This button will combine the scanning and saving process. You will be
prompted for 2 directories, first the input and then the output. Images will be scanned then when
scanning is complete they will be saved directly to the output directory without displaying the images
in the window.
This will improve performance where large numbers of images loading into the viewing window was
reducing the processing speed.
#### Note on future feature
---
It is intended that a feature will be added to allow users to manually add images as key images where they are not detected with a QR code.
This will allow users to images where the QR code may not have been detected or where it was forgotten. That is the primary purpose of the
intermediate preview window but this feature is not implemented yet.
Raw data
{
"_id": null,
"home_page": "",
"name": "qrImageIndexerGUI",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "sorter,qrcode,photosorter",
"author": "",
"author_email": "Jonathan Pecar <jonathan.pecar@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c2/eb/ce25ad56aed77d8f2329579654954c9b7b0064b617df694e626887253771/qrImageIndexerGUI-0.3.3.tar.gz",
"platform": null,
"description": "# qrCodeImageSorterGUI\nGUI interface for the [qrCodeImageSorter](https://github.com/jonpecar/qrCodeImageSorter) repository. For detailed information on the philosophy \nof the tool see the readme in this repository. This is a GUI interface for this underlying toolset.\n\n## A Quick (but rough) Video Guide\n\nhttps://user-images.githubusercontent.com/65805625/192924326-2560853a-2418-4b95-8806-40d787ae489c.mp4\n\n## Installation\n\nTo install the tool, run the below command with any version of Python above 3.7:\n\n```pip install qrImageIndexerGUI```\n\n## Instructions\n---\n\n### Launch Window\n---\n\nTo load the launch window, run the command:\n\n```python -m qrImageIndexerGUI```\n\nThis will present the user with the following window:\n\n\n\nFrom here you can open either the window for generating the QR codes or for sorting the resultant images.\n\n### Generate QR Codes\n---\n\nThis window allows the user to generate QR codes. It also provides a preview of what the output PDF will look like:\n\n\nThe available controls are listed below:\n1. Save PDF generated based on the listed inputs to file;\n2. Update sample PDF based on the listed inputs;\n3. Toggle sorting of PDF for slicing or down the page;\n4. Toggle generating QR codes for heading lines;\n5. Toggle reapeating of parent headings on every line of the PDF;\n6. Toggle inclusion of a prefix in the QR code;\n7. Configure prefix to include;\n8. Tab-delineated item input;\n9. Sample PDF display.\n\nThe recommended settings are set by default. In most situations the user should just enter their own text in the \ntext entry field (8).\n\n### Sort Images\n---\n\nThis window allows the user to sort photos that have been taken with QR codes in them. The interface will look similar to the below. \nNote that the provided screenshot is shown after having scanned a folder of images for demonstration. It will be blank prior to this:\n\n\nThe available controls are listed below:\n1. Scan images from a selected directory. This will open a prompt asking the user to select a directory;\n2. Save sorted images in a directory. This will save the images in the folder structure dictaged by the detected QR codes;\n3. Progress bar to indicate image scanning progress;\n4. Indicate whether QR codes have a prefix attached;\n5. Specify QR code prefix if used;\n6. Display images where QR codes are detected;\n\n 6.1. Path to specified image;\n \n 6.2. Thumbnail of image;\n \n 6.3. Path detected in QR code.\n\n#### Not Shown: New Feature - Quick Sort\n\nThere is now a quick sort button. This button will combine the scanning and saving process. You will be\nprompted for 2 directories, first the input and then the output. Images will be scanned then when\nscanning is complete they will be saved directly to the output directory without displaying the images\nin the window.\n\nThis will improve performance where large numbers of images loading into the viewing window was\nreducing the processing speed.\n\n\n#### Note on future feature\n---\n\nIt is intended that a feature will be added to allow users to manually add images as key images where they are not detected with a QR code. \nThis will allow users to images where the QR code may not have been detected or where it was forgotten. That is the primary purpose of the\nintermediate preview window but this feature is not implemented yet.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 jonpecar Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "GUI interface for tool for indexing images with QR codes",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/jonpecar/qrCodeImageSorterGUI"
},
"split_keywords": [
"sorter",
"qrcode",
"photosorter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6eac1f55a1db278892239f0261810722ccf8974b322b74f5874a02aa1403d7af",
"md5": "fcea01d50b6416a4e83ed81a6f3b705c",
"sha256": "188d36c6eef500994ac126b0406ea93793ae6d118fe48ab4d6d1805ed18d181d"
},
"downloads": -1,
"filename": "qrImageIndexerGUI-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fcea01d50b6416a4e83ed81a6f3b705c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12578,
"upload_time": "2023-08-16T04:38:13",
"upload_time_iso_8601": "2023-08-16T04:38:13.261628Z",
"url": "https://files.pythonhosted.org/packages/6e/ac/1f55a1db278892239f0261810722ccf8974b322b74f5874a02aa1403d7af/qrImageIndexerGUI-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c2ebce25ad56aed77d8f2329579654954c9b7b0064b617df694e626887253771",
"md5": "c8fda04926e35db21bfb8946eeaec0c0",
"sha256": "87027f0ff1f79e1292c584aea7e77c2d046cf403c0186ada20814b81394820e0"
},
"downloads": -1,
"filename": "qrImageIndexerGUI-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "c8fda04926e35db21bfb8946eeaec0c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14707,
"upload_time": "2023-08-16T04:38:14",
"upload_time_iso_8601": "2023-08-16T04:38:14.841458Z",
"url": "https://files.pythonhosted.org/packages/c2/eb/ce25ad56aed77d8f2329579654954c9b7b0064b617df694e626887253771/qrImageIndexerGUI-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-16 04:38:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jonpecar",
"github_project": "qrCodeImageSorterGUI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "qrimageindexergui"
}
