chezmoi-autosync 0.1.0__tar.gz

chezmoi_autosync-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,84 @@
+name: Publish to PyPI
+
+# Publishes on a version tag (v*) using PyPI "trusted publishing" via OIDC —
+# no PYPI_API_TOKEN secret is stored, and PEP 740 attestations (provenance) are
+# attached automatically by pypa/gh-action-pypi-publish.
+#
+# One-time setup on pypi.org (the project can be registered as a "pending"
+# publisher before it exists, and is created on first publish):
+#   pypi.org -> Account settings -> Publishing -> Add a pending publisher
+#     -> GitHub Actions:
+#        Owner:              bootswithdefer
+#        Repository:         chezmoi-autosync
+#        Workflow filename:  publish.yml
+#        Environment name:   pypi
+#   Then require manual approval on the "pypi" environment:
+#     repo Settings -> Environments -> pypi -> Required reviewers.
+#
+# Release flow:
+#   1. bump "version" in pyproject.toml
+#   2. git tag -a vX.Y.Z -m "vX.Y.Z" && git push origin vX.Y.Z
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+
+      # Guard against publishing a tag whose version does not match the package
+      # metadata. Skipped on manual (workflow_dispatch) runs that are not tags.
+      - name: Verify tag matches pyproject.toml version
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          pkg="$(uv version --short)"
+          if [ "$tag" != "$pkg" ]; then
+            echo "::error::Tag v$tag does not match pyproject.toml version $pkg"
+            exit 1
+          fi
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    # Only publish from a version tag, never from a manual dispatch on a branch.
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/chezmoi-autosync
+    permissions:
+      id-token: write # mandatory for OIDC trusted publishing
+    steps:
+      - name: Download the dists
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

chezmoi_autosync-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.venv/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/

chezmoi_autosync-0.1.0/LICENSE

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

chezmoi_autosync-0.1.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.5
+Name: chezmoi-autosync
+Version: 0.1.0
+Summary: Daemon that watches chezmoi source directory and auto-pushes changes to a hostname-based branch for review
+Project-URL: Homepage, https://github.com/bootswithdefer/chezmoi-autosync
+Project-URL: Repository, https://github.com/bootswithdefer/chezmoi-autosync
+Project-URL: Issues, https://github.com/bootswithdefer/chezmoi-autosync/issues
+Author: Jesse DeFer
+License-Expression: MIT
+License-File: LICENSE
+Keywords: chezmoi,daemon,dotfiles,sync
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: No Input/Output (Daemon)
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Requires-Dist: watchdog<6,>=4.0.0
+Description-Content-Type: text/markdown
+
+# chezmoi-autosync
+
+Daemon that watches your chezmoi-managed dotfiles for local edits and automatically pushes them to a hostname-based branch for review. Never lose a dotfile change because you forgot to commit.
+
+## How it works
+
+1. On startup, queries `chezmoi managed` to discover which files in `$HOME` chezmoi tracks
+2. Watches those files for changes using inotify (via [watchdog](https://github.com/gorakhargosh/watchdog))
+3. When a change is detected, debounces for a few seconds (coalesces rapid edits)
+4. Runs `chezmoi re-add` to capture the change into the chezmoi source directory
+5. Commits and pushes to a branch named `auto/<hostname>` on the remote
+
+You then review and merge the branch at your convenience — the daemon never touches `main` or `master`.
+
+## Install
+
+```bash
+uv tool install chezmoi-autosync
+```
+
+Or with pip:
+
+```bash
+pip install chezmoi-autosync
+```
+
+## Usage
+
+```bash
+# Start with defaults (watches ~/.local/share/chezmoi, pushes to auto/<hostname>)
+chezmoi-autosync
+
+# Custom source directory
+chezmoi-autosync --source-dir ~/dotfiles
+
+# Custom branch name
+chezmoi-autosync --branch auto/my-laptop
+
+# Custom remote and debounce interval
+chezmoi-autosync --remote upstream --debounce 10
+
+# Perform a single sync-and-push cycle and exit (no watching)
+chezmoi-autosync --once
+
+# Preview what would be synced without re-adding, committing, or pushing
+chezmoi-autosync --once --dry-run
+
+# Debug logging
+chezmoi-autosync -v
+```
+
+### Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--source-dir` | `~/.local/share/chezmoi` | Path to chezmoi source directory |
+| `--remote` | `origin` | Git remote name |
+| `--branch` | `auto/<hostname>` | Branch to push to |
+| `--debounce` | `5.0` | Seconds to wait after last change before syncing |
+| `--once` | off | Perform a single sync-and-push cycle and exit, without watching |
+| `--dry-run` | off | Report what would be synced without re-adding, committing, or pushing |
+| `-v` / `--verbose` | off | Enable debug logging |
+
+## Systemd user service
+
+A systemd user service unit is included for running chezmoi-autosync as a persistent background service.
+
+### Install the service
+
+```bash
+# Copy the unit file
+mkdir -p ~/.config/systemd/user
+cp systemd/chezmoi-autosync.service ~/.config/systemd/user/
+
+# Or if installed via uv tool install, link from the package:
+# The service file expects chezmoi-autosync to be in ~/.local/bin/
+
+# Enable and start
+systemctl --user daemon-reload
+systemctl --user enable --now chezmoi-autosync
+
+# Check status
+systemctl --user status chezmoi-autosync
+
+# View logs
+journalctl --user -u chezmoi-autosync -f
+```
+
+### Override settings
+
+```bash
+systemctl --user edit chezmoi-autosync
+```
+
+Then add overrides:
+
+```ini
+[Service]
+ExecStart=
+ExecStart=%h/.local/bin/chezmoi-autosync --debounce 10 --branch auto/work-laptop -v
+```
+
+## Branch safety
+
+The daemon has multiple layers of protection against accidentally modifying `main` or `master`:
+
+- **Startup validation** — refuses to start if the target branch is `main` or `master`
+- **Pre-push validation** — checks the target branch name before every push
+- **Commits never touch your checkout** — the daemon writes each snapshot directly onto the `auto/<hostname>` branch using git plumbing (`write-tree` in a temporary index, `commit-tree`, then `update-ref`). It never runs `git commit` against your current checkout and never moves `HEAD`, so the source repo can stay on `main` during normal operation. Your working index is left untouched (staging happens in a throwaway index).
+- **Mergeable history** — each snapshot is parented so the `auto/<hostname>` branch stays a clean, mergeable delta against your base branch. The daemon builds on the previous auto-branch tip only while that tip is *ahead* of the base (stacked, un-merged snapshots); once the base branch moves forward — because you merged the auto branch, or committed dotfiles to `main` directly — the next snapshot **re-roots on the base branch tip** instead of stacking on a now-stale sibling. This keeps the branch reviewable and mergeable with a normal pull request and prevents it from going stale after a merge.
+- **Explicit refspec** — pushes use `refs/heads/<branch>:refs/heads/<branch>` to be explicit about the target.
+- **Force-push to auto branches** — the `auto/<hostname>` branch is a per-machine scratch branch. The local state is always authoritative, so the daemon force-pushes. This means if the remote branch diverges (e.g., from a prior session or a GitHub edit), the local version wins. This is intentional — the branch exists to capture the latest state of *this machine's* dotfiles.
+
+If any safety check fails, the daemon logs a critical error but stays running — it will retry on the next file change once the issue is resolved.
+
+## Error handling
+
+The daemon is designed to stay alive through transient failures:
+
+- **chezmoi re-add fails** — logged, sync skipped, retries on next change
+- **git push fails** — logged (e.g., network down), retries on next change
+- **Initial sync fails** — logged, daemon continues watching
+- **Watch directory doesn't exist** — skipped with a warning
+
+Only critical startup errors cause the daemon to exit:
+- Source directory doesn't exist
+- Source directory isn't a git repo
+- Target branch is protected (`main`/`master`)
+- chezmoi reports no managed files
+
+## Development
+
+```bash
+# Clone
+git clone https://github.com/bootswithdefer/chezmoi-autosync
+cd chezmoi-autosync
+
+# Install dev dependencies
+uv sync --group dev
+```
+
+Common tasks are wrapped in a [`justfile`](https://github.com/casey/just). Run `just` (or `just --list`) to see everything available:
+
+```bash
+just test        # run the test suite (uv run pytest)
+just lint        # ruff check
+just fmt         # ruff format --line-length 160
+just fmt-check   # ruff format --check
+just typecheck   # ty check
+just check       # lint + fmt-check + typecheck + test
+
+# run the tool from the repo without installing
+just watch       # watch mode with debug logging
+just once        # single sync-and-push cycle
+just preview     # --once --dry-run (read-only)
+
+# install as a user tool + systemd service
+just install
+```
+
+The task recipes accept pass-through arguments, e.g. `just once --branch auto/laptop` or `just test -k dry_run`.
+
+If you don't have `just`, the underlying commands are plain `uv`/`uvx` invocations — see the `justfile` for the exact commands.
+
+## Installing as a service
+
+`just install` installs the tool with `uv tool install` (placing `chezmoi-autosync` in `~/.local/bin`), installs the systemd user unit, and enables + starts it:
+
+```bash
+just install
+```
+
+This is equivalent to the manual steps in [Systemd user service](#systemd-user-service) above. After installing, manage it with the usual `systemctl --user` / `journalctl --user` commands.
+
+## License
+
+MIT

chezmoi_autosync-0.1.0/README.md

@@ -0,0 +1,177 @@
+# chezmoi-autosync
+
+Daemon that watches your chezmoi-managed dotfiles for local edits and automatically pushes them to a hostname-based branch for review. Never lose a dotfile change because you forgot to commit.
+
+## How it works
+
+1. On startup, queries `chezmoi managed` to discover which files in `$HOME` chezmoi tracks
+2. Watches those files for changes using inotify (via [watchdog](https://github.com/gorakhargosh/watchdog))
+3. When a change is detected, debounces for a few seconds (coalesces rapid edits)
+4. Runs `chezmoi re-add` to capture the change into the chezmoi source directory
+5. Commits and pushes to a branch named `auto/<hostname>` on the remote
+
+You then review and merge the branch at your convenience — the daemon never touches `main` or `master`.
+
+## Install
+
+```bash
+uv tool install chezmoi-autosync
+```
+
+Or with pip:
+
+```bash
+pip install chezmoi-autosync
+```
+
+## Usage
+
+```bash
+# Start with defaults (watches ~/.local/share/chezmoi, pushes to auto/<hostname>)
+chezmoi-autosync
+
+# Custom source directory
+chezmoi-autosync --source-dir ~/dotfiles
+
+# Custom branch name
+chezmoi-autosync --branch auto/my-laptop
+
+# Custom remote and debounce interval
+chezmoi-autosync --remote upstream --debounce 10
+
+# Perform a single sync-and-push cycle and exit (no watching)
+chezmoi-autosync --once
+
+# Preview what would be synced without re-adding, committing, or pushing
+chezmoi-autosync --once --dry-run
+
+# Debug logging
+chezmoi-autosync -v
+```
+
+### Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--source-dir` | `~/.local/share/chezmoi` | Path to chezmoi source directory |
+| `--remote` | `origin` | Git remote name |
+| `--branch` | `auto/<hostname>` | Branch to push to |
+| `--debounce` | `5.0` | Seconds to wait after last change before syncing |
+| `--once` | off | Perform a single sync-and-push cycle and exit, without watching |
+| `--dry-run` | off | Report what would be synced without re-adding, committing, or pushing |
+| `-v` / `--verbose` | off | Enable debug logging |
+
+## Systemd user service
+
+A systemd user service unit is included for running chezmoi-autosync as a persistent background service.
+
+### Install the service
+
+```bash
+# Copy the unit file
+mkdir -p ~/.config/systemd/user
+cp systemd/chezmoi-autosync.service ~/.config/systemd/user/
+
+# Or if installed via uv tool install, link from the package:
+# The service file expects chezmoi-autosync to be in ~/.local/bin/
+
+# Enable and start
+systemctl --user daemon-reload
+systemctl --user enable --now chezmoi-autosync
+
+# Check status
+systemctl --user status chezmoi-autosync
+
+# View logs
+journalctl --user -u chezmoi-autosync -f
+```
+
+### Override settings
+
+```bash
+systemctl --user edit chezmoi-autosync
+```
+
+Then add overrides:
+
+```ini
+[Service]
+ExecStart=
+ExecStart=%h/.local/bin/chezmoi-autosync --debounce 10 --branch auto/work-laptop -v
+```
+
+## Branch safety
+
+The daemon has multiple layers of protection against accidentally modifying `main` or `master`:
+
+- **Startup validation** — refuses to start if the target branch is `main` or `master`
+- **Pre-push validation** — checks the target branch name before every push
+- **Commits never touch your checkout** — the daemon writes each snapshot directly onto the `auto/<hostname>` branch using git plumbing (`write-tree` in a temporary index, `commit-tree`, then `update-ref`). It never runs `git commit` against your current checkout and never moves `HEAD`, so the source repo can stay on `main` during normal operation. Your working index is left untouched (staging happens in a throwaway index).
+- **Mergeable history** — each snapshot is parented so the `auto/<hostname>` branch stays a clean, mergeable delta against your base branch. The daemon builds on the previous auto-branch tip only while that tip is *ahead* of the base (stacked, un-merged snapshots); once the base branch moves forward — because you merged the auto branch, or committed dotfiles to `main` directly — the next snapshot **re-roots on the base branch tip** instead of stacking on a now-stale sibling. This keeps the branch reviewable and mergeable with a normal pull request and prevents it from going stale after a merge.
+- **Explicit refspec** — pushes use `refs/heads/<branch>:refs/heads/<branch>` to be explicit about the target.
+- **Force-push to auto branches** — the `auto/<hostname>` branch is a per-machine scratch branch. The local state is always authoritative, so the daemon force-pushes. This means if the remote branch diverges (e.g., from a prior session or a GitHub edit), the local version wins. This is intentional — the branch exists to capture the latest state of *this machine's* dotfiles.
+
+If any safety check fails, the daemon logs a critical error but stays running — it will retry on the next file change once the issue is resolved.
+
+## Error handling
+
+The daemon is designed to stay alive through transient failures:
+
+- **chezmoi re-add fails** — logged, sync skipped, retries on next change
+- **git push fails** — logged (e.g., network down), retries on next change
+- **Initial sync fails** — logged, daemon continues watching
+- **Watch directory doesn't exist** — skipped with a warning
+
+Only critical startup errors cause the daemon to exit:
+- Source directory doesn't exist
+- Source directory isn't a git repo
+- Target branch is protected (`main`/`master`)
+- chezmoi reports no managed files
+
+## Development
+
+```bash
+# Clone
+git clone https://github.com/bootswithdefer/chezmoi-autosync
+cd chezmoi-autosync
+
+# Install dev dependencies
+uv sync --group dev
+```
+
+Common tasks are wrapped in a [`justfile`](https://github.com/casey/just). Run `just` (or `just --list`) to see everything available:
+
+```bash
+just test        # run the test suite (uv run pytest)
+just lint        # ruff check
+just fmt         # ruff format --line-length 160
+just fmt-check   # ruff format --check
+just typecheck   # ty check
+just check       # lint + fmt-check + typecheck + test
+
+# run the tool from the repo without installing
+just watch       # watch mode with debug logging
+just once        # single sync-and-push cycle
+just preview     # --once --dry-run (read-only)
+
+# install as a user tool + systemd service
+just install
+```
+
+The task recipes accept pass-through arguments, e.g. `just once --branch auto/laptop` or `just test -k dry_run`.
+
+If you don't have `just`, the underlying commands are plain `uv`/`uvx` invocations — see the `justfile` for the exact commands.
+
+## Installing as a service
+
+`just install` installs the tool with `uv tool install` (placing `chezmoi-autosync` in `~/.local/bin`), installs the systemd user unit, and enables + starts it:
+
+```bash
+just install
+```
+
+This is equivalent to the manual steps in [Systemd user service](#systemd-user-service) above. After installing, manage it with the usual `systemctl --user` / `journalctl --user` commands.
+
+## License
+
+MIT

chezmoi_autosync-0.1.0/justfile

@@ -0,0 +1,50 @@
+# chezmoi-autosync task runner
+# Run `just` or `just --list` to see available recipes.
+
+# Show available recipes
+default:
+    @just --list
+
+# Run the daemon (watch mode) with debug logging
+watch *args:
+    uv run chezmoi-autosync -v {{ args }}
+
+# Perform a single sync-and-push cycle and exit
+once *args:
+    uv run chezmoi-autosync --once {{ args }}
+
+# Preview what would be synced without re-adding, committing, or pushing
+preview *args:
+    uv run chezmoi-autosync --once --dry-run {{ args }}
+
+# Run the test suite
+test *args:
+    uv run pytest {{ args }}
+
+# Lint with ruff
+lint:
+    uvx ruff check .
+
+# Format with ruff
+fmt:
+    uvx ruff format --line-length 160 .
+
+# Check formatting without modifying files
+fmt-check:
+    uvx ruff format --line-length 160 --check .
+
+# Type-check with ty
+typecheck:
+    uvx ty check
+
+# Run all checks: lint, format check, type check, tests
+check: lint fmt-check typecheck test
+
+# Install as a user tool and enable the systemd user service
+install:
+    uv tool install --force .
+    mkdir -p ~/.config/systemd/user
+    cp systemd/chezmoi-autosync.service ~/.config/systemd/user/
+    systemctl --user daemon-reload
+    systemctl --user enable --now chezmoi-autosync
+    systemctl --user status --no-pager chezmoi-autosync

chezmoi_autosync-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "chezmoi-autosync"
+version = "0.1.0"
+description = "Daemon that watches chezmoi source directory and auto-pushes changes to a hostname-based branch for review"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [{ name = "Jesse DeFer" }]
+keywords = ["chezmoi", "dotfiles", "sync", "daemon"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: No Input/Output (Daemon)",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Systems Administration",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "watchdog>=4.0.0,<6",
+]
+
+[project.urls]
+Homepage = "https://github.com/bootswithdefer/chezmoi-autosync"
+Repository = "https://github.com/bootswithdefer/chezmoi-autosync"
+Issues = "https://github.com/bootswithdefer/chezmoi-autosync/issues"
+
+[project.scripts]
+chezmoi-autosync = "chezmoi_autosync.cli:main"
+
+[tool.ruff]
+line-length = 160
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0,<9",
+    "pytest-cov>=5.0,<7",
+]

chezmoi_autosync-0.1.0/src/chezmoi_autosync/__init__.py

@@ -0,0 +1,3 @@
+"""chezmoi-autosync: daemon that watches chezmoi source directory and auto-pushes changes."""
+
+__version__ = "0.1.0"