Files
SaraSort/README.md
T
sarahandClaude Opus 5.5 e90f59bc16 Look like SaraFem and SaraSuite: no custom title bar
The window keeps its own title bar (or none, per HideWindowTitleBar), with
SaraSuite's header (name, Add to app menu for AppImages, gear). Settings
is now a dialog laid out like SaraFem's, with export/import on the
SaraSuite tab, and notifications use SaraFem's tinted toast style.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-07 22:36:04 +02:00

69 lines
3.9 KiB
Markdown

# SaraSort
A GUI for configuring [SaraSortd](https://git.srhtnin.garden/sarah/SaraSortd), built with Flet.
SaraSort doesn't sort anything itself: SaraSortd stays the backend, and SaraSort reads and edits its
configs and controls its systemd user service.
Needs SaraSortd **7.1** or newer for arrows with their own patterns (per-entry `ValidInputDirs`).
## Pages
- **Flow**: every input (red), output (blue) and both (purple) directory as a box, with arrows labelled
with the file patterns that travel along them. Click a label to see all of its patterns. Boxes start in
columns and can be dragged (positions are kept in `Layout.toml`).
In **Edit mode**: click a directory, then the one it should sort into, and type the patterns. Each
pattern becomes its own `[[Files]]` entry in the output's config, with its own `ValidInputDirs`, and
the other settings come from `OutputDirConf.toml` (the template). Click a label to add or remove
patterns, remove the arrow, or save it as a template. Click a box to remove it or open its config.
- **Service**: running/stopped, start/stop/restart, start on login, SaraSortd's version (and the
SaraSuite install it came from), and its logs: its own log files or the systemd journal.
- **Configs**: `GlobalConf.toml`, the two templates and every directory's own config, as a form (with
help text, a live NewFileName preview and variable buttons) or as raw TOML. Saving only writes the
values you changed, so SaraSortd's own NextNum/NextChar/LastFile updates aren't overwritten.
- **Templates**: ready-made connections (Pictures, Videos, Music, Documents, Archives, Git repositories,
Logs, 3D printing, Installers, Backup copy) that only ask for an input and an output. Your own templates
are TOML files in `~/.config/SaraSuite/SaraSort/Templates/`.
- **Tools**: warnings about the setup (Unset values, version mismatches, outputs nothing reaches, inputs
without outputs, entries shadowed by a catch-all), a filename tester that shows where a file would go
and why, and the files in FailedDir with a retry button.
The gear button opens **Settings**, laid out like SaraFem's and SaraSuite's: the shared SaraSuite
appearance and export/import (same file format as SaraFem's, `[SaraSuite]` plus `[SaraSort]`), SaraSort's
own settings, and where SaraSortd lives. Run as an AppImage, the header also has an "Add to app menu"
button, like SaraSuite's.
After a change to `GlobalConf.toml` (new inputs or outputs) SaraSort restarts SaraSortd, since SaraSortd
only reads that file when it starts. That can be turned off in Settings.
## Where things live
| Path | What |
| --- | --- |
| `~/.config/SaraSuite/Config.toml` | shared SaraSuite settings (theme, font, title bar) |
| `~/.config/SaraSuite/Themes/` | the themes |
| `~/.config/SaraSuite/SaraSort/Config.toml` | SaraSort's own settings |
| `~/.config/SaraSuite/SaraSort/Layout.toml` | where flowchart boxes were dragged to |
| `~/.config/SaraSuite/SaraSort/Templates/` | your own templates |
| `~/.config/SaraSuite/SaraSortd/` | SaraSortd's configs, as SaraSuite installs them (changeable in Settings) |
## Running and building
- From source: `python3 -m venv .venv && .venv/bin/pip install -r requirements.txt`, then `Packaging/Launch.sh`.
- AppImage: `Packaging/BuildAppImage.sh` builds `dist/SaraSort-x86_64.AppImage` (PyInstaller one-file
build + `appimagetool`, like SaraSuite's and SaraFem's).
- SaraSuite: `Packaging/SaraSuite/` is a ready manifest (`Manifest.toml` + `Templates/`) to copy into
SaraSuite's `Programs/SaraSort/`.
## Files
| File | What |
| --- | --- |
| `Main.py` | window, navigation |
| `Core.py` | paths, palette/theme, settings, export/import |
| `Sortd.py` | SaraSortd's configs: the graph, edits, the filename simulator, warnings |
| `Service.py` | systemctl and journalctl |
| `Templates.py` | built-in and your own templates |
| `Settings.py` | the Settings dialog |
| `Widgets.py` | the shared App context and small controls |
| `*Page.py` | one per page |