yd-cli 0.10__tar.gz → 0.12__tar.gz

{yd_cli-0.10 → yd_cli-0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yd-cli
-Version: 0.10
+Version: 0.12
 Summary: CLI tool to synchronize directories using rsync.
 Author: Christian Heinze
 License-Expression: MIT
@@ -14,9 +14,9 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: System :: Archiving
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Dist: msgspec>=0.20
-Requires-Dist: rich>=14.3
-Requires-Dist: typer>=0.24
+Requires-Dist: msgspec>=0.21
+Requires-Dist: rich>=15
+Requires-Dist: typer>=0.26
 Requires-Python: >=3.14
 Project-URL: Repository, https://codeberg.org/christianheinze/yd-cli
 Description-Content-Type: text/markdown
@@ -25,6 +25,26 @@ Description-Content-Type: text/markdown
 
 Build and execute `rsync` commands from *TOML* configuration files.
 
+## (Un)Install
+
+To install, run
+
+```bash
+uv tool install yd-cli
+```
+
+Then run
+
+```bash
+yd --install-completion
+```
+
+to install auto-completion in your shell.
+
+In `bash`, the completion code is stored in `~/.bash_completions/yd.sh` and that file is sourced from `~/.bashrc`.
+Remove both and call `uv tool uninstall yd-cli` to remove this tool.
+The below mentioned configuration files need to be removed separately.
+
 ## Create a config
 
 Create a new configuration called `photos` with:
@@ -36,7 +56,7 @@ yd edit --new photos
 This command
 
 - creates `~/.config/yd/photos.toml` (or under `$XDG_CONFIG_HOME/yd` if set; relative paths are resolved from your home directory), and
-- opens it in the editor selected via `EDITOR`.
+- opens it with the executable selected via `EDITOR`, or `nvim` when `EDITOR` is unset.
 
 Reopen an existing configuration with:
 
@@ -72,7 +92,7 @@ Leading comment lines directly at the top of the file are treated as the configu
 | Key | Meaning |
 | --- | --- |
 | `src_home` | Base directory for all `src` paths. Relative paths are resolved from your home directory. |
-| `target_home` | Base directory for all target paths. Relative paths are resolved from your home directory. `strftime` placeholders such as `%Y-%m-%d` are supported. |
+| `target_home` | Base directory for all target paths. Relative paths are resolved from your home directory. |
 | `mtp_target` | Use in-place syncing for MTP targets. |
 | `backup` | Backup directory for replaced or deleted files. Relative paths are resolved from `target_home`. `strftime` placeholders are supported. |
 | `exclude` | Exclude patterns applied to every command. |
@@ -84,17 +104,20 @@ Leading comment lines directly at the top of the file are treated as the configu
 | Key | Meaning |
 | --- | --- |
 | `src` | Relative source directory below `src_home`. |
-| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders are supported. |
+| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders (`%Y`, `%m`, and `%d` only!) are supported. A newly created dated target is removed if it contains only directories after synchronization. |
 | `delete_extra` | Delete files in the target that do not exist in the source. Defaults to `true`. |
 | `exclude` | Extra exclude patterns for this command only. |
 
 ### Notes
 
 - `src` and `target` must stay within `src_home` and `target_home` after path resolution.
+- Literal targets are retained when they contain only empty directories. Dated targets serve as snapshots: if a dated target did not exist before synchronization and contains neither files nor symlinks afterward, `yd` removes its empty directory tree.
 - `src_home` or `target_home` may be omitted from the configuration, but every missing value must then be supplied when running (via CLI parameters).
 - Exactly one of `--src-home -` and `--target-home -` may read from standard input in a single run.
 - If `backup` is omitted, `yd` creates a timestamped backup directory automatically unless `--no-backup` is specified.
-- If a configured source directory exists but is empty, `yd` reports that no synchronization was performed for that command. E.g., forgetting to mount an external drive does not delete all corresponding copies on harddrive).
+- If a configured source directory exists but is empty, `yd` reports that no synchronization was performed for that command. E.g., forgetting to mount an external drive does not delete all corresponding copies on hard-drive.
+- If `strftime` placeholders are included in the `target`, then the `target_home` is scanned for matching directories (possibly) created by this rule before today.
+  The 20 most recent matches are included as additional comparison destinations in the synchronization: if a file in `src` is included in one of those reference directories, then it will not be copied to `target`.
 
 ## Run a config
 
@@ -115,6 +138,14 @@ yd run photos
 | `--src-home PATH` | Override `src_home` from the config. Use `-` to read the value from standard input. |
 | `--target-home PATH` | Override `target_home` from the config. Use `-` to read the value from standard input. |
 
+## Logging
+
+Set `YD_LOGLEVEL` to a numeric [Python logging level](https://docs.python.org/3/library/logging.html#logging-levels), such as `10` for debug, `20` for info, or `40` for errors.
+When set, `yd` appends *JSON* Lines records to `.yd.jsonl` in the current working directory.
+Records contain `time`, `level`, `logger`, and `message` fields, plus exception `type`, `message`, and `traceback` when applicable.
+
+Logging is effectively disabled by default. Enable it when diagnosing a failed or interrupted run.
+
 ## List configs
 
 List available configurations with:
@@ -128,5 +159,5 @@ This shows the configuration name together with the optional leading-comment des
 ## Why `yd`?
 
 - Has one character from `synchronize` and one from `directory`.
-- Easy to type with both *QWERTZ* and *QUERTY* keyboards.
+- Easy to type with both *QWERTZ* and *QWERTY* keyboards.
 - Name was still available on *PyPI*.

{yd_cli-0.10 → yd_cli-0.12}/README.md

@@ -2,6 +2,26 @@
 
 Build and execute `rsync` commands from *TOML* configuration files.
 
+## (Un)Install
+
+To install, run
+
+```bash
+uv tool install yd-cli
+```
+
+Then run
+
+```bash
+yd --install-completion
+```
+
+to install auto-completion in your shell.
+
+In `bash`, the completion code is stored in `~/.bash_completions/yd.sh` and that file is sourced from `~/.bashrc`.
+Remove both and call `uv tool uninstall yd-cli` to remove this tool.
+The below mentioned configuration files need to be removed separately.
+
 ## Create a config
 
 Create a new configuration called `photos` with:
@@ -13,7 +33,7 @@ yd edit --new photos
 This command
 
 - creates `~/.config/yd/photos.toml` (or under `$XDG_CONFIG_HOME/yd` if set; relative paths are resolved from your home directory), and
-- opens it in the editor selected via `EDITOR`.
+- opens it with the executable selected via `EDITOR`, or `nvim` when `EDITOR` is unset.
 
 Reopen an existing configuration with:
 
@@ -49,7 +69,7 @@ Leading comment lines directly at the top of the file are treated as the configu
 | Key | Meaning |
 | --- | --- |
 | `src_home` | Base directory for all `src` paths. Relative paths are resolved from your home directory. |
-| `target_home` | Base directory for all target paths. Relative paths are resolved from your home directory. `strftime` placeholders such as `%Y-%m-%d` are supported. |
+| `target_home` | Base directory for all target paths. Relative paths are resolved from your home directory. |
 | `mtp_target` | Use in-place syncing for MTP targets. |
 | `backup` | Backup directory for replaced or deleted files. Relative paths are resolved from `target_home`. `strftime` placeholders are supported. |
 | `exclude` | Exclude patterns applied to every command. |
@@ -61,17 +81,20 @@ Leading comment lines directly at the top of the file are treated as the configu
 | Key | Meaning |
 | --- | --- |
 | `src` | Relative source directory below `src_home`. |
-| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders are supported. |
+| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders (`%Y`, `%m`, and `%d` only!) are supported. A newly created dated target is removed if it contains only directories after synchronization. |
 | `delete_extra` | Delete files in the target that do not exist in the source. Defaults to `true`. |
 | `exclude` | Extra exclude patterns for this command only. |
 
 ### Notes
 
 - `src` and `target` must stay within `src_home` and `target_home` after path resolution.
+- Literal targets are retained when they contain only empty directories. Dated targets serve as snapshots: if a dated target did not exist before synchronization and contains neither files nor symlinks afterward, `yd` removes its empty directory tree.
 - `src_home` or `target_home` may be omitted from the configuration, but every missing value must then be supplied when running (via CLI parameters).
 - Exactly one of `--src-home -` and `--target-home -` may read from standard input in a single run.
 - If `backup` is omitted, `yd` creates a timestamped backup directory automatically unless `--no-backup` is specified.
-- If a configured source directory exists but is empty, `yd` reports that no synchronization was performed for that command. E.g., forgetting to mount an external drive does not delete all corresponding copies on harddrive).
+- If a configured source directory exists but is empty, `yd` reports that no synchronization was performed for that command. E.g., forgetting to mount an external drive does not delete all corresponding copies on hard-drive.
+- If `strftime` placeholders are included in the `target`, then the `target_home` is scanned for matching directories (possibly) created by this rule before today.
+  The 20 most recent matches are included as additional comparison destinations in the synchronization: if a file in `src` is included in one of those reference directories, then it will not be copied to `target`.
 
 ## Run a config
 
@@ -92,6 +115,14 @@ yd run photos
 | `--src-home PATH` | Override `src_home` from the config. Use `-` to read the value from standard input. |
 | `--target-home PATH` | Override `target_home` from the config. Use `-` to read the value from standard input. |
 
+## Logging
+
+Set `YD_LOGLEVEL` to a numeric [Python logging level](https://docs.python.org/3/library/logging.html#logging-levels), such as `10` for debug, `20` for info, or `40` for errors.
+When set, `yd` appends *JSON* Lines records to `.yd.jsonl` in the current working directory.
+Records contain `time`, `level`, `logger`, and `message` fields, plus exception `type`, `message`, and `traceback` when applicable.
+
+Logging is effectively disabled by default. Enable it when diagnosing a failed or interrupted run.
+
 ## List configs
 
 List available configurations with:
@@ -105,5 +136,5 @@ This shows the configuration name together with the optional leading-comment des
 ## Why `yd`?
 
 - Has one character from `synchronize` and one from `directory`.
-- Easy to type with both *QWERTZ* and *QUERTY* keyboards.
+- Easy to type with both *QWERTZ* and *QWERTY* keyboards.
 - Name was still available on *PyPI*.

{yd_cli-0.10 → yd_cli-0.12}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "uv-build>=0.10,<0.12" ]
 
 [project]
 name = "yd-cli"
-version = "0.10"
+version = "0.12"
 description = "CLI tool to synchronize directories using rsync."
 readme = "README.md"
 license = "MIT"
@@ -23,9 +23,9 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "msgspec>=0.20",
-    "rich>=14.3",
-    "typer>=0.24",
+    "msgspec>=0.21",
+    "rich>=15",
+    "typer>=0.26",
 ]
 urls.Repository = "https://codeberg.org/christianheinze/yd-cli"
 scripts.yd = "yd.cli:app"
@@ -38,9 +38,8 @@ dev = [
     { include-group = "test" },
 ]
 test = [
-    # pytest-asyncio does not support pytest>=9 yet.
+    "anyio>=4.12",
     "pytest>=9",
-    "pytest-asyncio>=1.3",
     "pytest-cov>=7",
     "pytest-randomly>=4",
 ]
@@ -51,8 +50,8 @@ format = [
     "ruff>=0.15.8",
 ]
 lint = [
+    "pyrefly>=1",
     "ruff>=0.15.8",
-    "ty>=0.0.27",
 ]
 
 [tool.uv]
@@ -116,6 +115,7 @@ lint.select = [
 lint.ignore = [
     # Any allowed.
     "ANN401",
+    # Using pathlib operations in coroutines is ok here.
     "COM812",
     "COM819",
     # Missing documentation allowed.
@@ -173,28 +173,26 @@ lint.flake8-type-checking.runtime-evaluated-decorators = [
     "pydantic.validate_call",
 ]
 lint.flake8-unused-arguments.ignore-variadic-names = true
-lint.isort.required-imports = [ "from __future__ import annotations" ]
 
 [tool.pyproject-fmt]
 column_width = 88
 indent = 4
 max_supported_python = "3.14"
 
-[tool.ty]
-environment.python-platform = "linux"
-environment.root = [ "src/" ]
-src.include = [ "src/", "tests/" ]
-src.respect-ignore-files = false
+[tool.pyrefly]
+min-severity = "info"
+preset = "strict"
+project-includes = [ "src/**/*.py", "tests/**/*.py", "scripts/*.py" ]
+use-ignore-files = false
 
 [tool.pytest]
-minversion = "9.0"
 addopts = [
     "--import-mode=importlib",
     "--strict-markers",
     "--cov=yd",
     "--cov=tests",
 ]
-testpaths = [ "tests" ]
-python_files = [ "test_*.py" ]
 filterwarnings = [ "error" ]
-asyncio_default_fixture_loop_scope = "function"
+minversion = "9.0"
+python_files = [ "test_*.py" ]
+testpaths = [ "tests" ]

{yd_cli-0.10 → yd_cli-0.12}/src/yd/__init__.py

@@ -8,8 +8,6 @@ triggers `__getattr__` and thereby eager importing of the module. Instead, impor
 `yd` and use attribute access.
 """
 
-from __future__ import annotations
-
 import importlib
 import importlib.metadata
 

{yd_cli-0.10 → yd_cli-0.12}/src/yd/__main__.py

@@ -3,8 +3,6 @@
 # SPDX-License-Identifier: MIT
 """CLI entry point."""
 
-from __future__ import annotations
-
 if __name__ == "__main__":
     from yd import cli