Metadata-Version: 2.4
Name: watchback
Version: 0.1.4
Summary: Simple backup utility
Author-email: Ali Aman <ali.aman.burki@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Ali Aman
        
        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.
        
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PySide6<7.0,>=6.0
Requires-Dist: watchdog<7.0,>=5.0
Requires-Dist: pyinstaller<7.0,>=6.0
Dynamic: license-file

# Watchback
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)

Simple desktop backup app: pick a source folder, pick one or more mirror folders, click `Sync`, and Watchback keeps mirrors updated.

## Quick Start

1. Install:
```bash
pip install -e .
```
2. Run:
```bash
watchback
```
3. In the app:
- Click `Add Profile`
- Add at least 2 folders
- Double-click one folder to mark it as `[GROUND]` (source of truth)
- Click `Save Profile`
- Click `Sync`

That is it. While sync is running, file changes are mirrored automatically.

## Open Existing Mirror (No Profile Needed)

If you attach a drive that already contains a Watchback mirror, you can use it directly:

1. Click `Open Mirror`
2. Select the mirror folder
3. Choose one of:
- `Explore Current`
- `Explore Versions`
- `Explore Snapshots`

You can export files from the mirror without creating a local profile first.

## What It Stores In Mirrors

Each mirror gets:

```text
mirror/
├── current/    # live copy
├── versions/   # older file versions
├── snapshots/  # periodic state history
└── objects/    # content storage used by versions/snapshots
```

## Build Executables (PyInstaller)

Generate a standalone executable for your host OS with:

```bash
python scripts/build.py
```

The script detects the current OS and runs the correct PyInstaller command.

- On Windows, output is `dist/watchback.exe`
- On Linux, output is `dist/watchback`

## Important Notes

- Sync direction is one-way: `GROUND -> MIRROR`.
- Do not edit files inside mirror folders directly.
- Settings and logs are stored in:
  - `~/.watchback/watchback.json`
  - `~/.watchback/watchback.log`

## Requirements

- Python `3.9+`
- Linux, macOS, or Windows

## License

MIT. See `LICENSE`.
