fspachinko 0.0.2__tar.gz

fspachinko-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wonyoung Jang
+
+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.

fspachinko-0.0.2/PKG-INFO

@@ -0,0 +1,322 @@
+Metadata-Version: 2.4
+Name: fspachinko
+Version: 0.0.2
+Summary: Transfer random files from directory A to directory B.
+Author: Wonyoung Jang
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: cyclopts>=4.4.5
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pyinstaller>=6.18.0
+Requires-Dist: pyside6>=6.10.1
+Requires-Dist: qt-material>=2.17
+Requires-Python: >=3.14
+Project-URL: Documentation, https://wonyoung-jang.github.io/fspachinko/
+Project-URL: Repository, https://github.com/wonyoung-jang/fspachinko
+Project-URL: Issues, https://github.com/wonyoung-jang/fspachinko/issues
+Description-Content-Type: text/markdown
+
+# fspachinko
+
+Transfer random files from point A to point B. Customize what and how to transfer with various filters. Supports copy, move, symlink (shortcut), and hardlink transfer operations.
+
+## Installation (uv)
+
+```bash
+uv add fspachinko
+```
+
+or
+
+```bash
+uv tool install fspachinko
+```
+
+![Setup](resources/images/tab_output.png)
+![Filter](resources/images/tab_filters.png)
+![Options](resources/images/tab_options.png)
+
+## Usage
+
+fspachinko can be used via command-line interface (CLI) or graphical user interface (GUI).
+
+## Command Line Interface
+
+### Basic Usage
+
+```bash
+# Use configuration file
+fspachinko-cli --config your-fspachinko.json
+```
+
+## Graphical User Interface
+
+### Launch GUI
+
+```bash
+fspachinko-gui
+```
+
+Or simply:
+
+```bash
+fspachinko
+```
+
+### GUI Profiles
+
+Save frequently used configurations as profiles:
+
+1. Configure settings in the GUI
+2. Click **File → Save Profile As**
+3. Name your profile (e.g., "music_copy")
+4. Load later with **File → Load Profile**
+
+## Configuration File
+
+Create a `fspachinko.json` file for reusable configurations. Pass this to the CLI after the `--config` flag. The default (for Windows) is shown below:
+
+```json
+{
+    "root": "C:/",
+    "dest": "fspachinko_output/",
+    "filecount": {
+        "count": 20,
+        "is_rand_enabled": false,
+        "rand_min": 1,
+        "rand_max": 12
+    },
+    "folder": {
+        "should_create": true,
+        "is_unique": true,
+        "name": "test_folder_output",
+        "count": 10
+    },
+    "filename": {
+        "template": "{original}"
+    },
+    "transfermode": {
+        "transfer_mode": "Symlink",
+        "trash_empty_folder_enabled": false
+    },
+    "keyword": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": ""
+    },
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "wav"
+    },
+    "filesize": {
+        "is_enabled": false,
+        "minimum": 0.0,
+        "maximum": 0.0
+    },
+    "duration": {
+        "is_enabled": false,
+        "minimum": 0.0,
+        "maximum": 0.0
+    },
+    "folder_size_limit": {
+        "is_enabled": false,
+        "size_limit": 500.0
+    },
+    "total_size_limit": {
+        "is_enabled": false,
+        "size_limit": 500.0
+    },
+    "options": {
+        "max_per_folder": 3,
+        "should_follow_symlink": false,
+        "is_dry_run": true
+    }
+}
+```
+
+## Example Configurations
+
+### Random Music Playlist
+
+```json
+{
+    "root": "~/Music",
+    "dest": "~/Playlists/Random",
+    "filecount": {
+        "count": 50,
+        ...
+    },
+    ...
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "wav,flac,m4a"
+    },
+    ...
+    "options": {
+        "max_per_folder": 2,
+        ...
+    }
+}
+```
+
+### Photo Gallery Selection
+
+```json
+{
+    "root": "~/Photos",
+    "dest": "~/Gallery",
+    "filecount": {
+        "count": 20,
+        ...
+    },
+    ...
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "jpg,png"
+    },
+    "filesize": {
+        "is_enabled": true,
+        "is_enabled": true,
+        "minimum": 1.0,
+        ...
+    },
+    "keyword": {
+        "should_include": false,
+        "text": "thumbnail,draft"
+    },
+    ...
+}
+```
+
+### Video Highlights
+
+```json
+{
+    "root": "~/Videos",
+    "dest": "~/Highlights",
+    "filecount": {
+        "count": 10,
+        ...
+    },
+    ...
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "mp4"
+    },
+    "duration": {
+        "is_enabled": true,
+        "minimum": 30.0,
+        "maximum": 600.0
+    },
+    ...
+}
+```
+
+### Safe Preview (Dry Run)
+
+```json
+{
+    "root": "/important/files",
+    "dest": "/backup",
+    "filecount": {
+        "count": 100,
+        ...
+    },
+    ...
+    "options": {
+        ...
+        "is_dry_run": true
+    }
+}
+```
+
+## Advanced Features
+
+### Output Filename Templates
+
+Use template variables in filenames:
+
+- `{original}`: Original filename
+- `{index}`: Sequential number
+- `{date}`: Current date (YYYY-MM-DD)
+- `{time}`: Current time (HH-MM-SS)
+- `{datetime}`: Combined date and time
+- `{parent}`: Parent folder name
+- `{parentstoroot}`: Full parent path separated by `-`
+
+Example: `{index}_{original}_{date}`: `photo.jpg` -> `1_photo_2026-01-25.jpg`
+
+### Logging
+
+Configure logging in a `json` file. Here is the default `fspachinko_configs/logging.json` provided:
+
+```json
+{
+    "version": 1,
+    "disable_existing_loggers": false,
+    "formatters": {
+        "file": {
+            "format": "[%(asctime)s] %(levelname)s[%(module)s] %(message)s"
+        },
+        "console": {
+            "format": "[%(asctime)s] %(levelname)s[%(module)s] %(message)s"
+        }
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "console",
+            "level": "INFO",
+            "stream": "ext://sys.stdout"
+        },
+        "file": {
+            "class": "logging.FileHandler",
+            "formatter": "file",
+            "level": "DEBUG",
+            "filename": "fspachinko.log",
+            "mode": "w",
+            "encoding": "utf-8",
+            "delay": true
+        }
+    },
+    "root": {
+        "level": "DEBUG",
+        "handlers": [
+            "console",
+            "file"
+        ]
+    }
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**No files found:**
+
+- Check your filters (extension, keyword, size)
+- Verify source path exists and contains matching files
+- Try `--dry-run` to see what would be selected
+
+**Permission errors:**
+
+- Ensure read access to source directory
+- Ensure write access to destination directory
+- Try running with appropriate permissions
+
+**Hardlink errors:**
+
+- Source and destination must be on same filesystem
+- Not supported on all filesystems (e.g., FAT32)
+- Falls back to symlink automatically
+
+**Duration filter not working:**
+
+- Requires ffmpeg installed on system
+- Only works with media files (video/audio)
+- Check file format is supported by ffmpeg

fspachinko-0.0.2/README.md

@@ -0,0 +1,304 @@
+# fspachinko
+
+Transfer random files from point A to point B. Customize what and how to transfer with various filters. Supports copy, move, symlink (shortcut), and hardlink transfer operations.
+
+## Installation (uv)
+
+```bash
+uv add fspachinko
+```
+
+or
+
+```bash
+uv tool install fspachinko
+```
+
+![Setup](resources/images/tab_output.png)
+![Filter](resources/images/tab_filters.png)
+![Options](resources/images/tab_options.png)
+
+## Usage
+
+fspachinko can be used via command-line interface (CLI) or graphical user interface (GUI).
+
+## Command Line Interface
+
+### Basic Usage
+
+```bash
+# Use configuration file
+fspachinko-cli --config your-fspachinko.json
+```
+
+## Graphical User Interface
+
+### Launch GUI
+
+```bash
+fspachinko-gui
+```
+
+Or simply:
+
+```bash
+fspachinko
+```
+
+### GUI Profiles
+
+Save frequently used configurations as profiles:
+
+1. Configure settings in the GUI
+2. Click **File → Save Profile As**
+3. Name your profile (e.g., "music_copy")
+4. Load later with **File → Load Profile**
+
+## Configuration File
+
+Create a `fspachinko.json` file for reusable configurations. Pass this to the CLI after the `--config` flag. The default (for Windows) is shown below:
+
+```json
+{
+    "root": "C:/",
+    "dest": "fspachinko_output/",
+    "filecount": {
+        "count": 20,
+        "is_rand_enabled": false,
+        "rand_min": 1,
+        "rand_max": 12
+    },
+    "folder": {
+        "should_create": true,
+        "is_unique": true,
+        "name": "test_folder_output",
+        "count": 10
+    },
+    "filename": {
+        "template": "{original}"
+    },
+    "transfermode": {
+        "transfer_mode": "Symlink",
+        "trash_empty_folder_enabled": false
+    },
+    "keyword": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": ""
+    },
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "wav"
+    },
+    "filesize": {
+        "is_enabled": false,
+        "minimum": 0.0,
+        "maximum": 0.0
+    },
+    "duration": {
+        "is_enabled": false,
+        "minimum": 0.0,
+        "maximum": 0.0
+    },
+    "folder_size_limit": {
+        "is_enabled": false,
+        "size_limit": 500.0
+    },
+    "total_size_limit": {
+        "is_enabled": false,
+        "size_limit": 500.0
+    },
+    "options": {
+        "max_per_folder": 3,
+        "should_follow_symlink": false,
+        "is_dry_run": true
+    }
+}
+```
+
+## Example Configurations
+
+### Random Music Playlist
+
+```json
+{
+    "root": "~/Music",
+    "dest": "~/Playlists/Random",
+    "filecount": {
+        "count": 50,
+        ...
+    },
+    ...
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "wav,flac,m4a"
+    },
+    ...
+    "options": {
+        "max_per_folder": 2,
+        ...
+    }
+}
+```
+
+### Photo Gallery Selection
+
+```json
+{
+    "root": "~/Photos",
+    "dest": "~/Gallery",
+    "filecount": {
+        "count": 20,
+        ...
+    },
+    ...
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "jpg,png"
+    },
+    "filesize": {
+        "is_enabled": true,
+        "is_enabled": true,
+        "minimum": 1.0,
+        ...
+    },
+    "keyword": {
+        "should_include": false,
+        "text": "thumbnail,draft"
+    },
+    ...
+}
+```
+
+### Video Highlights
+
+```json
+{
+    "root": "~/Videos",
+    "dest": "~/Highlights",
+    "filecount": {
+        "count": 10,
+        ...
+    },
+    ...
+    "extension": {
+        "is_enabled": true,
+        "should_include": true,
+        "text": "mp4"
+    },
+    "duration": {
+        "is_enabled": true,
+        "minimum": 30.0,
+        "maximum": 600.0
+    },
+    ...
+}
+```
+
+### Safe Preview (Dry Run)
+
+```json
+{
+    "root": "/important/files",
+    "dest": "/backup",
+    "filecount": {
+        "count": 100,
+        ...
+    },
+    ...
+    "options": {
+        ...
+        "is_dry_run": true
+    }
+}
+```
+
+## Advanced Features
+
+### Output Filename Templates
+
+Use template variables in filenames:
+
+- `{original}`: Original filename
+- `{index}`: Sequential number
+- `{date}`: Current date (YYYY-MM-DD)
+- `{time}`: Current time (HH-MM-SS)
+- `{datetime}`: Combined date and time
+- `{parent}`: Parent folder name
+- `{parentstoroot}`: Full parent path separated by `-`
+
+Example: `{index}_{original}_{date}`: `photo.jpg` -> `1_photo_2026-01-25.jpg`
+
+### Logging
+
+Configure logging in a `json` file. Here is the default `fspachinko_configs/logging.json` provided:
+
+```json
+{
+    "version": 1,
+    "disable_existing_loggers": false,
+    "formatters": {
+        "file": {
+            "format": "[%(asctime)s] %(levelname)s[%(module)s] %(message)s"
+        },
+        "console": {
+            "format": "[%(asctime)s] %(levelname)s[%(module)s] %(message)s"
+        }
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "console",
+            "level": "INFO",
+            "stream": "ext://sys.stdout"
+        },
+        "file": {
+            "class": "logging.FileHandler",
+            "formatter": "file",
+            "level": "DEBUG",
+            "filename": "fspachinko.log",
+            "mode": "w",
+            "encoding": "utf-8",
+            "delay": true
+        }
+    },
+    "root": {
+        "level": "DEBUG",
+        "handlers": [
+            "console",
+            "file"
+        ]
+    }
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**No files found:**
+
+- Check your filters (extension, keyword, size)
+- Verify source path exists and contains matching files
+- Try `--dry-run` to see what would be selected
+
+**Permission errors:**
+
+- Ensure read access to source directory
+- Ensure write access to destination directory
+- Try running with appropriate permissions
+
+**Hardlink errors:**
+
+- Source and destination must be on same filesystem
+- Not supported on all filesystems (e.g., FAT32)
+- Falls back to symlink automatically
+
+**Duration filter not working:**
+
+- Requires ffmpeg installed on system
+- Only works with media files (video/audio)
+- Check file format is supported by ffmpeg

fspachinko-0.0.2/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "fspachinko"
+version = "0.0.2"
+description = "Transfer random files from directory A to directory B."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+requires-python = ">=3.14"
+dependencies = [
+    "cyclopts>=4.4.5",
+    "pydantic>=2.12.5",
+    "pyinstaller>=6.18.0",
+    "pyside6>=6.10.1",
+    "qt-material>=2.17",
+]
+authors = [
+    {name = "Wonyoung Jang"},
+]
+
+[project.urls]
+Documentation = "https://wonyoung-jang.github.io/fspachinko/"
+Repository = "https://github.com/wonyoung-jang/fspachinko"
+Issues = "https://github.com/wonyoung-jang/fspachinko/issues"
+
+[project.scripts]
+fspachinko = "fspachinko.gui.__main__:main"
+fspachinko-gui = "fspachinko.gui.__main__:main"
+fspachinko-cli = "fspachinko.cli.__main__:main"
+ 
+[build-system]
+requires = ["uv_build>=0.9.27,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.vulture]
+paths = ["./src/fspachinko", "whitelist.py"]
+ignore_decorators = ["@app.*"]
+min_confidence = 40
+verbose = false
+
+[dependency-groups]
+dev = [
+    "line-profiler>=5.0.0",
+    "tprof>=1.1.0",
+]
+docs = [
+    "mkdocstrings-python>=2.0.1",
+    "zensical>=0.0.19",
+]

fspachinko-0.0.2/src/fspachinko/__init__.py

@@ -0,0 +1,6 @@
+"""Main package."""
+
+
+def hello(n: int) -> str:
+    """Return a hello message with the sum of numbers from 1 to n."""
+    return f"Hello {n}!"