cullet 0.1.0__tar.gz

cullet-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 simon-ging
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cullet-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: cullet
+Version: 0.1.0
+Summary: Keyboard-driven photo viewer for culling, sorting, tagging and deduplicating.
+Author: simon-ging
+License-Expression: Apache-2.0
+Project-URL: Project-URL, https://github.com/simon-ging/cullet
+Keywords: photo,image,viewer,culling,duplicates
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Multimedia :: Graphics :: Viewers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PySide6
+Requires-Dist: Pillow
+Requires-Dist: natsort
+Requires-Dist: typedparser
+Requires-Dist: pathspec>=1.0
+Requires-Dist: filetype
+Provides-Extra: full
+Requires-Dist: torch; extra == "full"
+Requires-Dist: torchvision; extra == "full"
+Requires-Dist: tqdm; extra == "full"
+Requires-Dist: numpy; extra == "full"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: numpy; extra == "dev"
+Dynamic: license-file
+
+# cullet
+
+<p align="center">
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py310.yml">
+  <img alt="minimal build 3.10 status" title="minimal build 3.10 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py310.yml?branch=main&label=minimal%20build%203.10" />
+</a>
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py314.yml">
+  <img alt="minimal build 3.14 status" title="minimal build 3.14 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py314.yml?branch=main&label=minimal%20build%203.14" />
+</a>
+<br />
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py310-full.yml">
+  <img alt="full build 3.10 status" title="full build 3.10 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py310-full.yml?branch=main&label=full%20build%203.10" />
+</a>
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py314-full.yml">
+  <img alt="full build 3.14 status" title="full build 3.14 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py314-full.yml?branch=main&label=full%20build%203.14" />
+</a>
+<br />
+<img alt="coverage" title="coverage" src="https://raw.githubusercontent.com/simon-ging/cullet/main/docs/coverage.svg" />
+<a href="https://pypi.org/project/cullet/">
+  <img alt="version" title="version" src="https://img.shields.io/pypi/v/cullet?color=success" />
+</a>
+</p>
+
+Keyboard-driven photo viewer for going through a folder fast: step, zoom, rotate, delete, move
+into target folders, tag, and review duplicates. Press `h` in the viewer for the keys.
+
+## Install
+
+Requires `python>=3.10`
+
+```bash
+uv tool install cullet
+```
+
+or `pip install cullet` into an environment of your choice. Rotating JPEGs losslessly needs the
+`jpegtran` binary, which comes with `libjpeg-turbo` on most distributions.
+
+Finding duplicates and fixing rotations need torch, which comes with the full extra:
+
+```bash
+uv tool install "cullet[full]"
+```
+
+## Usage
+
+```bash
+cullet /path/to/photos
+cullet /path/to/photos/IMG_1234.jpg
+cullet /path/to/photos -a ../good -a ../maybe -T sun -T portrait
+cullet /path/to/photos --dedup
+```
+
+The number keys move the image into the target folders (`-a`) and toggle the tags (`-T`), in the
+order they are given. Deleted files are moved to the system trash, never removed (`--trash_dir`
+puts them into a folder of your choice instead), and every file operation can be undone with
+`u`. `cullet --help` lists all options.
+
+## Command line tools
+
+They only log what they would do until `-w` is given. Each has `--help`.
+
+| command | does | needs |
+| --- | --- | --- |
+| `cullet-dedup-images` | removes duplicate images, into the system trash or a folder with `-Q` | full extra |
+| `cullet-dedup-videos` | the same for videos | full extra, ffmpeg |
+| `cullet-fix-rotation-images` | finds photos stored sideways or upside down and rotates them | full extra |
+| `cullet-fix-rotation-videos` | the same for videos | full extra, ffmpeg |
+| `cullet-downscale-images` | shrinks images, keeping their metadata | |
+| `cullet-downscale-videos` | shrinks videos | ffmpeg |
+
+```bash
+cullet-dedup-videos /path/to/videos -Q /path/to/quarantine -w
+cullet-downscale-images /path/to/photos -s 1080 -w
+```
+
+## Install locally and run tests
+
+Clone repository and cd into. Setup python 3.10 or higher.
+Note: The tests that need torch are skipped unless it is installed.
+
+```bash
+pip install -e .[full,dev]
+pylint src
+
+# run tests
+python -m pytest --cov
+pylint tests
+```

cullet-0.1.0/README.md

@@ -0,0 +1,88 @@
+# cullet
+
+<p align="center">
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py310.yml">
+  <img alt="minimal build 3.10 status" title="minimal build 3.10 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py310.yml?branch=main&label=minimal%20build%203.10" />
+</a>
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py314.yml">
+  <img alt="minimal build 3.14 status" title="minimal build 3.14 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py314.yml?branch=main&label=minimal%20build%203.14" />
+</a>
+<br />
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py310-full.yml">
+  <img alt="full build 3.10 status" title="full build 3.10 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py310-full.yml?branch=main&label=full%20build%203.10" />
+</a>
+<a href="https://github.com/simon-ging/cullet/actions/workflows/build-py314-full.yml">
+  <img alt="full build 3.14 status" title="full build 3.14 status" src="https://img.shields.io/github/actions/workflow/status/simon-ging/cullet/build-py314-full.yml?branch=main&label=full%20build%203.14" />
+</a>
+<br />
+<img alt="coverage" title="coverage" src="https://raw.githubusercontent.com/simon-ging/cullet/main/docs/coverage.svg" />
+<a href="https://pypi.org/project/cullet/">
+  <img alt="version" title="version" src="https://img.shields.io/pypi/v/cullet?color=success" />
+</a>
+</p>
+
+Keyboard-driven photo viewer for going through a folder fast: step, zoom, rotate, delete, move
+into target folders, tag, and review duplicates. Press `h` in the viewer for the keys.
+
+## Install
+
+Requires `python>=3.10`
+
+```bash
+uv tool install cullet
+```
+
+or `pip install cullet` into an environment of your choice. Rotating JPEGs losslessly needs the
+`jpegtran` binary, which comes with `libjpeg-turbo` on most distributions.
+
+Finding duplicates and fixing rotations need torch, which comes with the full extra:
+
+```bash
+uv tool install "cullet[full]"
+```
+
+## Usage
+
+```bash
+cullet /path/to/photos
+cullet /path/to/photos/IMG_1234.jpg
+cullet /path/to/photos -a ../good -a ../maybe -T sun -T portrait
+cullet /path/to/photos --dedup
+```
+
+The number keys move the image into the target folders (`-a`) and toggle the tags (`-T`), in the
+order they are given. Deleted files are moved to the system trash, never removed (`--trash_dir`
+puts them into a folder of your choice instead), and every file operation can be undone with
+`u`. `cullet --help` lists all options.
+
+## Command line tools
+
+They only log what they would do until `-w` is given. Each has `--help`.
+
+| command | does | needs |
+| --- | --- | --- |
+| `cullet-dedup-images` | removes duplicate images, into the system trash or a folder with `-Q` | full extra |
+| `cullet-dedup-videos` | the same for videos | full extra, ffmpeg |
+| `cullet-fix-rotation-images` | finds photos stored sideways or upside down and rotates them | full extra |
+| `cullet-fix-rotation-videos` | the same for videos | full extra, ffmpeg |
+| `cullet-downscale-images` | shrinks images, keeping their metadata | |
+| `cullet-downscale-videos` | shrinks videos | ffmpeg |
+
+```bash
+cullet-dedup-videos /path/to/videos -Q /path/to/quarantine -w
+cullet-downscale-images /path/to/photos -s 1080 -w
+```
+
+## Install locally and run tests
+
+Clone repository and cd into. Setup python 3.10 or higher.
+Note: The tests that need torch are skipped unless it is installed.
+
+```bash
+pip install -e .[full,dev]
+pylint src
+
+# run tests
+python -m pytest --cov
+pylint tests
+```

cullet-0.1.0/pyproject.toml

@@ -0,0 +1,110 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cullet"
+description = "Keyboard-driven photo viewer for culling, sorting, tagging and deduplicating."
+readme = "README.md"
+authors = [{ "name" = "simon-ging" }]
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = ["photo", "image", "viewer", "culling", "duplicates"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: X11 Applications :: Qt",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: Multimedia :: Graphics :: Viewers",
+]
+dynamic = ["version", "dependencies"]
+
+[project.optional-dependencies]
+full = ["torch", "torchvision", "tqdm", "numpy"]
+dev = ["pytest", "pytest-cov", "pylint", "numpy"]
+
+[project.scripts]
+cullet = "cullet.cli:main"
+cullet-dedup-images = "cullet.cli_dedup_images:main"
+cullet-dedup-videos = "cullet.cli_dedup_videos:main"
+cullet-fix-rotation-images = "cullet.extras:fix_rotation_images"
+cullet-fix-rotation-videos = "cullet.extras:fix_rotation_videos"
+cullet-downscale-images = "cullet.cli_downscale_images:main"
+cullet-downscale-videos = "cullet.cli_downscale_videos:main"
+
+[project.urls]
+Project-URL = "https://github.com/simon-ging/cullet"
+
+[tool.setuptools]
+zip-safe = true
+platforms = ["any"]
+include-package-data = false
+
+[tool.setuptools.dynamic]
+version = { attr = "cullet.__version__" }
+dependencies = {file = ["requirements.txt"]}
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.black]
+line-length = 100
+
+[tool.coverage.run]
+source_pkgs = ["cullet"]
+branch = true
+
+[tool.coverage.report]
+skip_empty = true
+
+[tool.coverage.html]
+directory = ".covreport"
+
+[tool.coverage.xml]
+output = ".covreport/coverage.xml"
+
+[tool.pylint.main]
+jobs = 1
+extension-pkg-allow-list = ["PySide6"]
+
+[tool.pylint.messages_control]
+
+enable = "all"
+
+disable = [
+    'suppressed-message', 'locally-disabled', 'line-too-long', 'missing-module-docstring',
+    'missing-class-docstring', 'missing-function-docstring', 'fixme',
+    'f-string-without-interpolation', 'invalid-name',
+    'logging-fstring-interpolation', 'consider-iterating-dictionary',
+    'use-implicit-booleaness-not-comparison',
+    'attribute-defined-outside-init', 'consider-using-with', 'global-statement',
+    'import-outside-toplevel', 'super-init-not-called', 'broad-exception-caught',
+    'disallowed-name', 'redefined-outer-name', 'use-implicit-booleaness-not-comparison-to-zero',
+    'eval-used', 'unknown-option-value', 'arguments-differ', 'subprocess-run-check',
+    'use-implicit-booleaness-not-comparison-to-string', 'use-dict-literal',
+    'useless-suppression', 'too-many-positional-arguments', 'use-symbolic-message-instead',
+]
+
+[tool.pylint.format]
+max-line-length = 99999
+max-module-lines = 99999
+
+[tool.pylint.refactoring]
+max-nested-blocks = 9999
+
+[tool.pylint.design]
+max-args = 9999
+max-attributes = 9999
+max-bool-expr = 9999
+max-branches = 9999
+max-locals = 9999
+max-parents = 9999
+max-public-methods = 9999
+max-returns = 9999
+max-statements = 9999
+min-public-methods = 0

cullet-0.1.0/requirements.txt

@@ -0,0 +1,6 @@
+PySide6
+Pillow
+natsort
+typedparser
+pathspec>=1.0
+filetype

cullet-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cullet-0.1.0/src/cullet/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

cullet-0.1.0/src/cullet/__main__.py

@@ -0,0 +1,3 @@
+from cullet.cli import main
+
+main()