| Name | critiqypy JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | https://github.com/WetenSchaap/Critiqypy |
| Summary | Critiqypy is a File Categorizer Tool. It allows you to quickly view all files in a folder, and categorize them into categories you have defined. A straightforward example is looking through photos quickly, selecting some for printing, while discarding others. |
| upload_time | 2024-01-26 13:17:42 |
| maintainer | |
| docs_url | None |
| author | Piet J.M. Swinkels |
| requires_python | >=3.10,<4.0 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Critiqypy
Critiqypy is a simple File Categorizer Tool. It allows you to quickly view all files in a folder, and categorize them into categories you have defined. A straightforward example is looking through photos quickly, selecting some for printing, while discarding others.
I created this simple application, because I need to sort a lot of images and videos manually; I have a large amount of microscopy data, and it is easy to see whether further analysis is worth it by eye. Therefore, simply looking at all images and/or movies and manually separating them one-by-one became annoying, and I wrote this super-simple script to just go through all files.
## Usage
On the command line, simply run `critiqypy <path to folder with files to categorize> <path where to put the result>`.
More advanced options are given in the help menu (also shown below). A typical, more complicated example is:
```bash
critiqypy -cp /path/to/images/ /path/to/output/folder -c Bad Meh Good "Absolutely fantastic"
```
which will show you the images in `/path/to/images/` one by one, allowing you to sort them into one of the categories (Bad, Meh, Good, and Absolutely fantastic). When you sort an image into 'meh', a copy of the image is placed in `/path/to/output/folder/meh`.
```text
usage: Critiqypy [-h] [-c CATEGORY [CATEGORY ...]] [-j | -cp | -mv] folder_path destination
positional arguments:
folder_path Path to the folder containing files to categorize
destination Path to the folder to store categorized pictures, or to the location to save the json with results
options:
-h, --help show this help message and exit
-c CATEGORY [CATEGORY ...], --category CATEGORY [CATEGORY ...]
The categories to split the files into. Defaults to Yes & No, because that is probably what you want anyway. Can be any number you like.
-j, --json Write the categorization to the destination as a json file. Leave the original files alone.
-cp, --copy In the destination path, create subfolders with each category and place a //copy// of files in their respective categories
-mv, --move In the destination path, create subfolders with each category and //move// files to their respective categories
```
## Limitations
Currently, this script can only handle video and image files. Extending things shouldn't be too difficult (?), but I personally don't need it. I checked that the script runs on a Linux machine, the code *should* work on Windows and Mac as well, but your mileage may vary.
Internally, I use VLC to display movies, so any video that VLC can show should work. Images are handled by Pillow.
## Installation
Before installing this package, note that we use [VLC media player](https://www.videolan.org/vlc/) to display videos. If VLC is not installed, this script will not work. If VLC installed, simply install this package using your favourite python package installer, probably:
```
pip install critiqypy
```
Raw data
{
"_id": null,
"home_page": "https://github.com/WetenSchaap/Critiqypy",
"name": "critiqypy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Piet J.M. Swinkels",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ae/e8/af680c6d680b69d5a2ca4321c2607fd4e7b7bfe789558e9ff407b5fd0372/critiqypy-0.1.0.tar.gz",
"platform": null,
"description": "# Critiqypy\n\nCritiqypy is a simple File Categorizer Tool. It allows you to quickly view all files in a folder, and categorize them into categories you have defined. A straightforward example is looking through photos quickly, selecting some for printing, while discarding others.\n\nI created this simple application, because I need to sort a lot of images and videos manually; I have a large amount of microscopy data, and it is easy to see whether further analysis is worth it by eye. Therefore, simply looking at all images and/or movies and manually separating them one-by-one became annoying, and I wrote this super-simple script to just go through all files.\n\n## Usage\n\nOn the command line, simply run `critiqypy <path to folder with files to categorize> <path where to put the result>`.\nMore advanced options are given in the help menu (also shown below). A typical, more complicated example is:\n\n```bash\ncritiqypy -cp /path/to/images/ /path/to/output/folder -c Bad Meh Good \"Absolutely fantastic\"\n```\n\nwhich will show you the images in `/path/to/images/` one by one, allowing you to sort them into one of the categories (Bad, Meh, Good, and Absolutely fantastic). When you sort an image into 'meh', a copy of the image is placed in `/path/to/output/folder/meh`.\n\n```text\nusage: Critiqypy [-h] [-c CATEGORY [CATEGORY ...]] [-j | -cp | -mv] folder_path destination\n\npositional arguments:\n folder_path Path to the folder containing files to categorize\n destination Path to the folder to store categorized pictures, or to the location to save the json with results\n\noptions:\n -h, --help show this help message and exit\n -c CATEGORY [CATEGORY ...], --category CATEGORY [CATEGORY ...]\n The categories to split the files into. Defaults to Yes & No, because that is probably what you want anyway. Can be any number you like.\n -j, --json Write the categorization to the destination as a json file. Leave the original files alone.\n -cp, --copy In the destination path, create subfolders with each category and place a //copy// of files in their respective categories\n -mv, --move In the destination path, create subfolders with each category and //move// files to their respective categories\n```\n\n## Limitations\n\nCurrently, this script can only handle video and image files. Extending things shouldn't be too difficult (?), but I personally don't need it. I checked that the script runs on a Linux machine, the code *should* work on Windows and Mac as well, but your mileage may vary.\n\nInternally, I use VLC to display movies, so any video that VLC can show should work. Images are handled by Pillow.\n\n\n## Installation\n\nBefore installing this package, note that we use [VLC media player](https://www.videolan.org/vlc/) to display videos. If VLC is not installed, this script will not work. If VLC installed, simply install this package using your favourite python package installer, probably:\n\n```\npip install critiqypy\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Critiqypy is a File Categorizer Tool. It allows you to quickly view all files in a folder, and categorize them into categories you have defined. A straightforward example is looking through photos quickly, selecting some for printing, while discarding others.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/WetenSchaap/Critiqypy",
"Repository": "https://github.com/WetenSchaap/Critiqypy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e0eaed0bc918acdef23c78461c97da2aa49ac7d01406e654b812de292909fb9",
"md5": "d1d0ca9b5be61d1546321cea20c38aa4",
"sha256": "e3df08cb0a800fc81b9dd4c8107cad41c51b02d0c5959b2f7dc0a300ca7cc916"
},
"downloads": -1,
"filename": "critiqypy-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1d0ca9b5be61d1546321cea20c38aa4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 18079,
"upload_time": "2024-01-26T13:17:40",
"upload_time_iso_8601": "2024-01-26T13:17:40.129598Z",
"url": "https://files.pythonhosted.org/packages/7e/0e/aed0bc918acdef23c78461c97da2aa49ac7d01406e654b812de292909fb9/critiqypy-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aee8af680c6d680b69d5a2ca4321c2607fd4e7b7bfe789558e9ff407b5fd0372",
"md5": "ef1d2c3c86b5f912b0f8a1d2a7f7f257",
"sha256": "1816899f1760180c9c2aecfd66610ecac907d34ea9fa30f713447d2755361b6c"
},
"downloads": -1,
"filename": "critiqypy-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ef1d2c3c86b5f912b0f8a1d2a7f7f257",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 16901,
"upload_time": "2024-01-26T13:17:42",
"upload_time_iso_8601": "2024-01-26T13:17:42.435720Z",
"url": "https://files.pythonhosted.org/packages/ae/e8/af680c6d680b69d5a2ca4321c2607fd4e7b7bfe789558e9ff407b5fd0372/critiqypy-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-26 13:17:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WetenSchaap",
"github_project": "Critiqypy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "critiqypy"
}
