mackup-ng 0.11.1__tar.gz

mackup_ng-0.11.1/.github/CONTRIBUTING.md

@@ -0,0 +1,127 @@
+# How to contribute
+
+You can:
+
+- Add or improve the support of an application (Check the [TODO][TODO] and
+  [TOFIX][TOFIX] tasks and pick one)
+- Improve the mackup-ng codebase
+- Triage issues: reproduce bug reports or ask for vital information such as
+  version numbers or reproduction instructions.
+
+## Development Setup
+
+Mackup uses [uv](https://docs.astral.sh/uv/) for fast, reliable Python package management. Here's how to get started:
+
+### Prerequisites
+
+- Python 3.10 or higher
+- [uv](https://docs.astral.sh/uv/) installed
+
+Install uv if you haven't already:
+
+```bash
+# On macOS
+brew install uv
+
+# On Linux
+# Via pipx (recommended)
+pipx install uv
+
+# Or via Homebrew on Linux
+brew install uv
+
+# On Windows
+powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+Alternatively, see the [official uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for more options.
+
+### Setting Up Your Development Environment
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/grigorii-horos/mackup-ng.git
+cd mackup
+```
+
+2. Sync dependencies (creates a virtual environment automatically):
+
+```bash
+uv sync --dev
+```
+
+This will:
+
+- Create a `.venv` directory with a virtual environment
+- Install all project dependencies
+- Install development dependencies (pytest, mypy, etc.)
+
+### Running Tests and Checks
+
+Use the provided Make targets for quick development workflow:
+
+```bash
+# Run all checks (recommended before committing)
+make check
+
+# Run tests only
+make test
+
+# Run type checking
+make mypy
+
+# Run code linting
+make ruff
+```
+
+Or use `uv run` directly:
+
+```bash
+# Run tests
+uv run pytest
+
+# Run tests with verbose output
+uv run pytest -v
+
+# Run type checking
+uv run mypy mackup/
+
+# Run linting
+uv run ruff check .
+```
+
+### Code Quality Standards
+
+All pull requests must pass:
+
+- ✅ **Tests**: All pytest tests must pass
+- ✅ **Type checking**: No mypy errors
+- ✅ **Linting**: Code must pass ruff checks
+- ✅ **Formatting**: Follow existing code style
+
+Run `make check` before submitting your PR to ensure everything passes.
+
+## Contributing Guidelines
+
+To speed up Pull Request (PR) approval and merger into Mackup, please follow
+these guidelines:
+
+- Keep one application supported per PR
+- Add the application to the list of supported applications in
+  [README.md][README.md]
+- Sync configurations should follow the following principles:
+  - Syncing should not break the application, and PRs should be tested
+  - Syncing should not break any syncing functionality internal to the
+    application
+  - The configuration should sync the minimal set of data, so that syncing
+    happens quickly. Leave large app data out of the sync configuration.
+  - Do not sync any file or folder that represents some state, like session
+    data, cache, any file specific to the local workstation.
+  - Do not sync sensitive information, like clear passwords or private keys
+
+Thank you for your contribution!
+
+[TODO]: https://github.com/grigorii-horos/mackup-ng/labels/TODO
+[TOFIX]: https://github.com/grigorii-horos/mackup-ng/labels/TOFIX
+[README.md]: https://github.com/grigorii-horos/mackup-ng/blob/master/README.md

mackup_ng-0.11.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+### All submissions
+
+- [ ] I have followed the [Contributing Guidelines](https://github.com/grigorii-horos/mackup-ng/blob/master/.github/CONTRIBUTING.md)
+- [ ] I have checked to ensure there aren't other open [Pull Requests](https://github.com/grigorii-horos/mackup-ng/pulls) for the same update/change
+
+### Adding/updating Application X Support
+
+- [ ] This PR is only for one application
+- [ ] It has been added to the list of supported applications in the [README](https://github.com/grigorii-horos/mackup-ng/blob/master/README.md)
+- [ ] The configuration syncs the minimal set of data
+- [ ] No file specific to the local workstation is synced
+- [ ] No sensitive data is synced
+
+### Improving the Mackup codebase
+
+- [ ] My submission passes the [tests](https://github.com/grigorii-horos/mackup-ng/tree/master/tests)
+- [ ] I have linted the code locally prior to submission
+- [ ] I have written new tests as applicable
+- [ ] I have added an explanation of what the changes do

mackup_ng-0.11.1/.github/workflows/install.yaml

@@ -0,0 +1,42 @@
+name: install
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  install-on-linux:
+    strategy:
+      matrix:
+        os:
+          - ubuntu-22.04
+          - ubuntu-22.04-arm
+          - ubuntu-24.04
+          - ubuntu-24.04-arm
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    runs-on: ${{ matrix.os }}
+    container: python:${{ matrix.python-version }}
+    steps:
+      - uses: actions/checkout@v6
+      - run: pip install .
+      - run: mackup-ng --help
+
+  install-on-macos:
+    strategy:
+      matrix:
+        os:
+          - macos-14
+          - macos-15
+          - macos-15-intel
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - run: pip install .
+      - run: mackup-ng --help

mackup_ng-0.11.1/.github/workflows/linelint.yaml

@@ -0,0 +1,19 @@
+# Make sure that all text files end with a newline character.
+# Configure your editor to end every file with a newline character.
+# See <https://stackoverflow.com/a/729795>
+name: linelint
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  linelint:
+    runs-on: ubuntu-latest
+    name: linelint
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Linelint
+        uses: fernandrone/linelint@master

mackup_ng-0.11.1/.github/workflows/markdown.yaml

@@ -0,0 +1,16 @@
+name: markdown
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  rumdl:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync --all-extras --dev
+      - run: uv run rumdl check .

mackup_ng-0.11.1/.github/workflows/mypy.yaml

@@ -0,0 +1,18 @@
+name: mypy
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.10"
+      - run: uv sync --all-extras --dev
+      - run: uv run mypy src/mackup_ng/

mackup_ng-0.11.1/.github/workflows/release.yaml

@@ -0,0 +1,27 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "*"
+
+permissions:
+  contents: write  # create the GitHub release
+  id-token: write  # PyPI Trusted Publishing (OIDC)
+
+jobs:
+
+  release:
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - name: Publish to PyPI
+        run: uv publish
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: dist/*

mackup_ng-0.11.1/.github/workflows/ruff.yaml

@@ -0,0 +1,16 @@
+name: ruff
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync --all-extras --dev
+      - run: uv run ruff check .

mackup_ng-0.11.1/.github/workflows/snap.yaml

@@ -0,0 +1,24 @@
+name: snap
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    env:
+      SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAPCRAFT_STORE_CREDENTIALS }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: snapcore/action-build@v1
+        id: build
+      # Only publish when store credentials are configured, so forks without
+      # the secret still build (and pass) without trying to publish.
+      - uses: snapcore/action-publish@v1
+        if: github.ref == 'refs/heads/master' && env.SNAPCRAFT_STORE_CREDENTIALS != ''
+        with:
+          snap: ${{ steps.build.outputs.snap }}
+          release: edge

mackup_ng-0.11.1/.github/workflows/test.yaml

@@ -0,0 +1,26 @@
+name: test
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --all-extras --dev
+      - run: uv run pytest --cov=mackup_ng --cov-report=term

mackup_ng-0.11.1/.gitignore

@@ -0,0 +1,17 @@
+# Generated when running Mackup
+*.pyc
+
+# Generated by make release
+/dist/
+
+# Ignore Claude stuff
+/.claude/
+
+# Coverage reports
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/

mackup_ng-0.11.1/.linelint.yml

@@ -0,0 +1,19 @@
+# 'true' will fix files
+autofix: false
+
+# list of paths to ignore, uses gitignore syntaxes (executes before any rule)
+ignore:
+  - tests/fixtures/Library/Application Support/Box/Box Sync/sync_root_folder.txt
+  - tests/fixtures/Library/Mobile Documents/com~apple~CloudDocs/_blank_.md
+
+rules:
+  # checks if file ends in a newline character
+  end-of-file:
+    # set to true to enable this rule
+    enable: true
+
+    # set to true to disable autofix (if enabled globally)
+    disable-autofix: true
+
+    # if true also checks if file ends in a single newline character
+    single-new-line: true

mackup_ng-0.11.1/.rumdl_cache/.gitignore

@@ -0,0 +1,2 @@
+# Automatically created by rumdl.
+*

mackup_ng-0.11.1/.rumdl_cache/0.2.16/52dd18ffe6e7dbde30f36a2b61e8330db00eadaf51a117788d4b411e428675c9_b62e8f04acb7b922.json

@@ -0,0 +1,8 @@
+{
+  "file_hash": "52dd18ffe6e7dbde30f36a2b61e8330db00eadaf51a117788d4b411e428675c9",
+  "config_hash": "f80b97b67a3b17f97e4b6db9d75b8f2ca60176952c8fb66eae28008ca62eb771",
+  "rules_hash": "b62e8f04acb7b9225e844e934eca14212ed9142f04f8e6268e11902b9333a1fc",
+  "version": "0.2.16",
+  "warnings": [],
+  "timestamp": 1782052020
+}

mackup_ng-0.11.1/.rumdl_cache/0.2.16/57d073a0b89cdfa327ed1a216b7e401ba90b50873cd9a888d2863a22fb62db82_b62e8f04acb7b922.json

@@ -0,0 +1,8 @@
+{
+  "file_hash": "57d073a0b89cdfa327ed1a216b7e401ba90b50873cd9a888d2863a22fb62db82",
+  "config_hash": "f80b97b67a3b17f97e4b6db9d75b8f2ca60176952c8fb66eae28008ca62eb771",
+  "rules_hash": "b62e8f04acb7b9225e844e934eca14212ed9142f04f8e6268e11902b9333a1fc",
+  "version": "0.2.16",
+  "warnings": [],
+  "timestamp": 1782052020
+}

mackup_ng-0.11.1/.rumdl_cache/0.2.16/80fc68ec3100e8cd8d717260df26e5ad9dabbf9c4cc87649124129fabd5d5b2d_b62e8f04acb7b922.json

@@ -0,0 +1,8 @@
+{
+  "file_hash": "80fc68ec3100e8cd8d717260df26e5ad9dabbf9c4cc87649124129fabd5d5b2d",
+  "config_hash": "f80b97b67a3b17f97e4b6db9d75b8f2ca60176952c8fb66eae28008ca62eb771",
+  "rules_hash": "b62e8f04acb7b9225e844e934eca14212ed9142f04f8e6268e11902b9333a1fc",
+  "version": "0.2.16",
+  "warnings": [],
+  "timestamp": 1782052020
+}

mackup_ng-0.11.1/.rumdl_cache/0.2.16/e251b79fcb368fedeee0bc5f8fb968aed13c4462bf992ad7f79a2b240e7c5df3_b62e8f04acb7b922.json

@@ -0,0 +1,8 @@
+{
+  "file_hash": "e251b79fcb368fedeee0bc5f8fb968aed13c4462bf992ad7f79a2b240e7c5df3",
+  "config_hash": "f80b97b67a3b17f97e4b6db9d75b8f2ca60176952c8fb66eae28008ca62eb771",
+  "rules_hash": "b62e8f04acb7b9225e844e934eca14212ed9142f04f8e6268e11902b9333a1fc",
+  "version": "0.2.16",
+  "warnings": [],
+  "timestamp": 1782051849
+}

mackup_ng-0.11.1/.rumdl_cache/CACHEDIR.TAG

@@ -0,0 +1,2 @@
+Signature: 8a477f597d28d172789f06886806bc55
+# This file is a cache directory tag created by rumdl.

mackup_ng-0.11.1/AGENTS.md

@@ -0,0 +1,78 @@
+# AGENTS.md
+
+## Purpose
+
+This fork of `mackup` adds path templating in application config definitions
+(`src/mackup_ng/applications/*.cfg`). When editing or adding app configs, use the
+fork features below to avoid duplicated platform-specific entries.
+
+## Fork Path Templating (cfg files)
+
+Path templating is supported in `[configuration_files]` entries.
+
+### Built-in variables
+
+Use these Mackup-specific variables (not OS env vars):
+
+- `@CONFIG@` -> `.config` (Linux) / `Library/Application Support` (macOS) / `AppData/Roaming` (Windows)
+- `@DATA@` -> `.local/share` (Linux) / `Library/Application Support` (macOS) / `AppData/Local` (Windows)
+- `@STATE@` -> `.local/state` (Linux) / `Library/Application Support` (macOS) / `AppData/Local` (Windows)
+- `@CACHE@` -> `.cache` (Linux) / `Library/Caches` (macOS) / `AppData/Local` (Windows)
+
+### Platform selector
+
+Use `[...]` to choose a path fragment by platform:
+
+- Syntax: `[linux:...,mac:...,windows:...,fallback]`
+- The last unkeyed item is the fallback.
+- The fallback is also the canonical backup path used in the Mackup storage.
+
+Selector semantics in this fork:
+
+- local path = platform-specific value (or fallback if no matching key)
+- backup path = fallback (or selected path if no fallback is provided)
+- built-in variables in backup paths are resolved to Linux canonical values
+  (`@CONFIG@ -> .config`, `@DATA@ -> .local/share`, etc.)
+
+Examples:
+
+- `@CONFIG@/[mac:Blender,blender]`
+- `@CONFIG@/[mac:Sublime Text 3,sublime-text-3]/Packages/User`
+- `[mac:@CONFIG@/MyApp/config.json,linux:@CONFIG@/myapp/config.json,@CONFIG@/shared/myapp-config.json]`
+
+### Brace expansion
+
+Use `{...}` to define multiple entries in one line:
+
+- `@CONFIG@/Code/User/{snippets,keybindings.json,settings.json}`
+
+Brace groups are expanded recursively (cartesian product when multiple groups
+are present).
+
+## Processing Order
+
+Paths are resolved in this order:
+
+1. Platform selector `[...]`
+   Produces local path and canonical backup path
+2. Built-in variables (`@CONFIG@`, `@DATA@`, `@STATE@`, `@CACHE@`)
+   Local path uses current OS mapping; backup path uses Linux canonical mapping
+3. Brace expansion `{...}`
+
+## Config Style (This Fork)
+
+- Prefer `[configuration_files]` only.
+- `xdg_configuration_files` is unsupported in this fork. Use `@CONFIG@/...` in `[configuration_files]`.
+- Prefer a single templated line over duplicated macOS/Linux entries when
+  semantics are the same.
+- If macOS path naming differs, prefer a selector inside `@CONFIG@`, e.g.
+  `@CONFIG@/[mac:Foo App,foo-app]`.
+- Keep `Library/Preferences/...` entries as-is unless there is a clear
+  cross-platform equivalent.
+
+## Safety Notes
+
+- Paths that start with selectors (e.g. `[mac:...,fallback]/...`) are supported
+  by this fork, but they rely on fork-specific parsing logic in
+  `src/mackup_ng/appsdb.py`.
+- Upstream Mackup may not support these templates.

mackup_ng-0.11.1/INSTALL.md

@@ -0,0 +1,61 @@
+# Detailed install instructions for mackup-ng
+
+mackup-ng is distributed on PyPI as `mackup-ng`. Install it with either
+[pip](https://pip.pypa.io/en/stable/) or [uv](https://docs.astral.sh/uv/).
+
+## Install
+
+### With pip
+
+```bash
+pip install mackup-ng
+
+# Now you can run it
+mackup-ng -h
+```
+
+### With uv (isolated tool)
+
+```bash
+uv tool install mackup-ng
+
+mackup-ng -h
+```
+
+### Latest development version from GitHub
+
+```bash
+pip install "git+https://github.com/grigorii-horos/mackup-ng.git"
+
+mackup-ng -h
+```
+
+## Upgrade
+
+### Upgrade with pip
+
+```bash
+pip install --upgrade mackup-ng
+mackup-ng -h
+```
+
+### Upgrade with uv
+
+```bash
+uv tool upgrade mackup-ng
+mackup-ng -h
+```
+
+## Uninstall
+
+### Uninstall with pip
+
+```bash
+pip uninstall mackup-ng
+```
+
+### Uninstall with uv
+
+```bash
+uv tool uninstall mackup-ng
+```