Skip to main content

Pure python3 implementation for working with iDevices (iPhone, etc...)

Project description

PyMobileDevice3

Python application Pypi version Downloads Discord Ask DeepWiki

Overview

pymobiledevice3 is a pure Python 3 implementation for interacting with iOS devices (iPhone, iPad, ...). It includes both a CLI and a Python API and is supported on:

  • Windows
  • Linux
  • macOS

Main features:

  • Device discovery over bonjour
  • TCP port forwarding
  • Syslog and oslog streaming
  • Profile and application management
  • AFC file access
  • Crash report collection
  • Network sniffing (PCAP)
  • Firmware update
  • Recovery/DFU workflows
  • Notification listen/post (notify_post())
  • Querying and setting SpringBoard options
  • WebInspector automation
  • DDI/DVT developer tooling
  • Backup and restore

Quick Start

Install from PyPI:

python3 -m pip install -U pymobiledevice3

Or install from source:

git clone git@github.com:doronz88/pymobiledevice3.git
cd pymobiledevice3
python3 -m pip install -U -e .

Verify connectivity and run first commands:

pymobiledevice3 usbmux list
pymobiledevice3 syslog live
pymobiledevice3 apps list

Platform Notes

Support Matrix (Developer Services)

iOS >= 17 developer services require tunnel-based transport. The tunnel normally needs root/admin; on Python 3.14+ you can instead add --userspace to a developer command for a no-root, in-process tunnel (see the guide for what it supports).

Host OS iOS 17.0-17.3.1 iOS 17.4+
macOS Supported Supported
Windows Supported (requires additional drivers) Supported
Linux Limited Supported (lockdown tunnel)

See the detailed guide: iOS 17+ tunnels

Common CLI Tasks

See full recipes: CLI recipes

# List connected devices
pymobiledevice3 usbmux list

# Watch syslog
pymobiledevice3 syslog live

# Pull crash reports
pymobiledevice3 crash pull /path/to/crashes

# Mount DDI
pymobiledevice3 mounter auto-mount

# DVT screenshot (requires developer setup)
pymobiledevice3 developer dvt screenshot /path/to/screen.png

Install shell completions:

pymobiledevice3 install-completions

Python API and Protocol Internals

Documentation Map

See Documentation index for task-focused guides.

Contributing

See CONTRIBUTING and Code of Conduct. Agent-specific contributor guidance is in AGENTS.

License and Credits

This work is licensed under GPL 3.0 and credited to several major contributors:

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymobiledevice3-9.30.0.tar.gz (954.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymobiledevice3-9.30.0-py3-none-any.whl (975.6 kB view details)

Uploaded Python 3

File details

Details for the file pymobiledevice3-9.30.0.tar.gz.

File metadata

  • Download URL: pymobiledevice3-9.30.0.tar.gz
  • Upload date:
  • Size: 954.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pymobiledevice3-9.30.0.tar.gz
Algorithm Hash digest
SHA256 50c5970484ee7596f8f5f6f29085487c94b22149fda08b52ad8023c0cc36084d
MD5 132c8e05d9130d7f815567e23b4b841d
BLAKE2b-256 610abed65901a7c5fd1dcbcdd0c24d221117c3102678b60f3b230f52a594c0a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pymobiledevice3-9.30.0.tar.gz:

Publisher: python-publish.yml on doronz88/pymobiledevice3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pymobiledevice3-9.30.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pymobiledevice3-9.30.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1c69392d16dac7b1d8b61bf21d6782981de1c0d691a7be715adbe0291b4bf06
MD5 719fdb0e93103e1fd95583cfbefd0411
BLAKE2b-256 622f11b5669ebdb21a0a6889cf9f4d4f157c00fd3e3b378a7937e41a51e66805

See more details on using hashes here.

Provenance

The following attestation bundles were made for pymobiledevice3-9.30.0-py3-none-any.whl:

Publisher: python-publish.yml on doronz88/pymobiledevice3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page