partial-backup 0.0.1__tar.gz

partial_backup-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Test environment**
+- Host OS version.
+- Target device model and iOS version.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add logs including backtraces for the given error that help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
+
+## For community
+⬇️  **Please click the 👍 reaction instead of leaving a `+1` or 👍  comment**

partial_backup-0.0.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Just ask the community a question
+    url: https://discord.gg/52mZGC3JXJ
+    about: Community help about pymobiledevice3.
+

partial_backup-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+
+## For community
+
+⬇️  **Please click the 👍 reaction instead of leaving a `+1` or 👍  comment**

partial_backup-0.0.1/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+<!---
+
+Thanks for opening a PR on partial-backup!
+
+Please review the CONTRIBUTING.md first regarding the linters we use and how
+do we enforce them.
+
+-->
+
+## For community
+
+⬇️  **Please click the 👍 reaction instead of leaving a `+1` or 👍 comment**

partial_backup-0.0.1/.github/workflows/codeql.yml

@@ -0,0 +1,81 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+    paths:
+      - '.github/workflows/codeql.yml'
+      - 'pymobiledevice3/**'
+      - 'requirements.txt'
+      - 'pyproject.toml'
+  schedule:
+    - cron: '24 3 * * 6'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

partial_backup-0.0.1/.github/workflows/markdown-lint.yml

@@ -0,0 +1,26 @@
+name: Markdown linting
+
+on:
+  pull_request:
+    branches: [ "master" ]
+    paths:
+      - '**/*.md'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    if: '! github.event.pull_request.draft'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '20'
+      - name: Install Markdownlint CLI
+        run: npm install -g markdownlint-cli
+      - name: Run Markdownlint
+        run: markdownlint -c markdownlint-config.json "**/*.md"

partial_backup-0.0.1/.github/workflows/python-app.yml

@@ -0,0 +1,122 @@
+name: Python application
+
+on:
+  pull_request:
+    branches: [ "master" ]
+    paths:
+      - '.github/workflows/python-app.yml'
+      - 'pymobiledevice3/**'
+      - 'requirements.txt'
+      - 'pyproject.toml'
+  release:
+    types: [ created ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    if: '! github.event.pull_request.draft'
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13" ]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install pre-commit
+      - name: Run pre-commit hooks
+        run: |
+          pre-commit run --all-files
+      - name: Test install
+        run: |
+          python -m pip install -U '.[test]'
+      - name: Test show usage
+        run: pytest -m cli
+
+#  pyinstaller:
+#    needs: [ 'test' ]
+#    if: '! github.event.pull_request.draft'
+#    runs-on: ${{ matrix.os }}
+#
+#    strategy:
+#      matrix:
+#        python-version: [ "3.12" ]
+#        os: [ ubuntu-latest, macos-latest, windows-latest ]
+#
+#    steps:
+#      - uses: actions/checkout@v4
+#      - name: Set up Python
+#        uses: actions/setup-python@v4
+#        with:
+#          python-version: '3.x'
+#      - name: Install dependencies
+#        run: |
+#          python -m pip install --upgrade pip
+#          pip install -U . coloredlogs pyinstaller apple_compress
+#      - name: Build
+#        run: |
+#          python .github/workflows/generate-executable.py
+#
+#      - if: matrix.os == 'ubuntu-latest'
+#        name: Test ubuntu artifact
+#        run: |
+#          ./dist/pymobiledevice3
+#
+#      - if: matrix.os == 'macos-latest'
+#        name: Test macos artifact
+#        run: |
+#          ./dist/pymobiledevice3
+#
+#      - if: matrix.os == 'windows-latest'
+#        name: Test windows artifact
+#        run: |
+#          ./dist/pymobiledevice3.exe
+#
+#      - if: matrix.os == 'ubuntu-latest'
+#        name: Rename ubuntu artifact
+#        run: |
+#          mv ./dist/pymobiledevice3 ./dist/pymobiledevice3_ubuntu
+#      - if: matrix.os == 'macos-latest'
+#        name: Rename macos artifact
+#        run: |
+#          mv ./dist/pymobiledevice3 ./dist/pymobiledevice3_macos
+#
+#      - if: matrix.os == 'ubuntu-latest'
+#        name: Upload ubuntu artifact
+#        uses: actions/upload-artifact@v3
+#        with:
+#          name: pymobiledevice3_ubuntu
+#          path: ./dist/pymobiledevice3_ubuntu
+#      - if: matrix.os == 'macos-latest'
+#        name: Upload macos artifact
+#        uses: actions/upload-artifact@v3
+#        with:
+#          name: pymobiledevice3_macosx
+#          path: ./dist/pymobiledevice3_macos
+#      - if: matrix.os == 'windows-latest'
+#        name: Upload windows artifact
+#        uses: actions/upload-artifact@v3
+#        with:
+#          name: pymobiledevice3_windows.exe
+#          path: ./dist/pymobiledevice3.exe
+#
+#      - name: Upload server artifacts to GitHub Release
+#        if: github.event_name == 'release'
+#        uses: softprops/action-gh-release@v1
+#        with:
+#          files: |
+#            dist/pymobiledevice3_macos
+#            dist/pymobiledevice3_ubuntu
+#            dist/pymobiledevice3.exe
+#          token: ${{ secrets.GITHUB_TOKEN }}

partial_backup-0.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,29 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [ created ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -U build setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python -m build
+          twine upload dist/*

partial_backup-0.0.1/.gitignore

@@ -0,0 +1,166 @@
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+partial_backup/_version.py

partial_backup-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.9.3
+    hooks:
+      - id: isort
+        args: [ '-m', 'HANGING_INDENT', '-l', '120','--check-only' ]
+        files: .
+
+  - repo: https://github.com/pycqa/flake8
+    rev: "7.0.0"
+    hooks:
+      - id: flake8
+        args: [ '--max-line-length=127' ]
+        files: \.py$

partial_backup-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contibuting
+
+If you would like to contribute, feel free to report issues, start new discussions, or create pull requests.
+
+In general we recommend using our pre-commit hook which enforce the linter rules we use:
+
+```shell
+python3 -m pip install -U pre-commit
+pre-commit install
+```
+
+In addition, please note we prefer using `'` for strings instead of `"`.
+
+If you're having any troubles, You can also contact us on Discord:
+
+<https://discord.gg/52mZGC3JXJ>
+
+If you are lacking knowledge in how the different communication protocols work together, or how the project is
+structured in design-form, you are advised to read:
+
+[Understanding iDevice protocol layers](misc/understanding_idevice_protocol_layers.md)

partial_backup-0.0.1/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: partial-backup
+Version: 0.0.1
+Summary: Metadata-Aware Partial Backup Creator
+Project-URL: Homepage, https://github.com/doronz88/partial-backup
+Project-URL: Bug Reports, https://github.com/doronz88/partial-backup/issues
+Keywords: ios,backup,partial-backup
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pymobiledevice3>4.14.14
+Requires-Dist: bpylist2
+Requires-Dist: rich
+Requires-Dist: click
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+
+# 🗂️ partial-backup: Metadata-Aware Partial Backup Creator
+
+This utility scans a given directory in a structured *"unbacked"* format and generates a `Backup` object that can be
+written back as a valid backup. It preserves directory and file metadata such as ownership (`user_`), group (`group_`),
+and file mode (`mode_`), and skips common junk files.
+
+---
+
+## 📦 Features
+
+- Recursively scans a directory organized by *domain* (e.g., `HomeDomain`)
+- Supports embedded metadata in directory names (`user_501_group_0_mode_755`)
+- Preserves and serializes:
+  - File contents
+  - Directory structure
+  - Ownership and permissions
+- Skips system-specific noise like `.DS_Store` and `Thumbs.db`
+- Outputs a fully reconstructable `Backup` object
+- Simple CLI using [Typer](https://typer.tiangolo.com/)
+
+---
+
+## 🛠️ Installation
+
+```bash
+pip install partial-backup
+```
+
+## 🧪 Example Usage
+
+Assume your source directory is structured like this:
+
+```none
+unback/HomeDomain/
+├── user_501_group_0_mode_777/Library
+│   └── Preferences/
+│       └── com.example.settings.plist
+```
+
+To generate the backup:
+
+```shell
+partial-backup unback/ output/
+```
+
+It will:
+
+- Detect `HomeDomain`
+- Extract user/group/mode from directories like `user_501_group_0_mode_777`
+- Generate a Backup object
+- Save the reconstructed backup to `output/`
+
+## ♻️ Restore the Backup
+
+The generated backup is compatible with [pymobiledevice3](https://github.com/doronz88/pymobiledevice3), and can be
+restored to an iOS device using:
+
+```shell
+pymobiledevice3 backup2 restore /path/to/backup --source . --no-copy --system
+```
+
+## 📁 Metadata Syntax
+
+This tool supports optional metadata hints in folder names:
+
+| Syntax                       | Meaning ---                |
+|------------------------------|----------------------------|
+| `user_501`                   | File owned by user `501`   |
+| `group_20`                   | File belongs to group `20` |
+| `mode_755`                   | File or directory mode     |
+| `user_501_group_20_mode_644` | All of the above           |
+
+These metadata markers are automatically removed from paths and applied to the appropriate file or directory entry.
+
+## ⛔ Ignored Files
+
+The following files and folders are skipped automatically:
+
+- `.DS_Store`
+- `Thumbs.db`
+- `desktop.ini`
+- `.Spotlight-V100`
+- `.Trashes`
+
+## API Overview
+
+```python
+from pathlib import Path
+from partial_backup.backup import Backup
+
+backup = Backup.create_backup_from_directory(Path('/path/to/unback'))
+backup.write_to_directory(Path('/path/to/output'))
+```
+
+## 🙏 Acknowledgments
+
+Huge thanks to [@JJTech0130](https://github.com/JJTech0130) for his insights and foundational work on the backup DB
+implementation.