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.

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.12.0.tar.gz (767.7 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.12.0-py3-none-any.whl (803.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pymobiledevice3-9.12.0.tar.gz
Algorithm Hash digest
SHA256 bafe49b1fe3faf5405c14148910cf770334b67c2cf756ffa35e95c2853411d20
MD5 8407a534ee8933130155aac127633b35
BLAKE2b-256 9bec402b74ac20a2436940a0c31a534ad774f63e6455766cc8b180538e86b664

See more details on using hashes here.

Provenance

The following attestation bundles were made for pymobiledevice3-9.12.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.12.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pymobiledevice3-9.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50a5c441213df6a0cc238e086f46e5579c0aff4303bac312f9c900202c973c99
MD5 f3c59e98d85d121e058ce208930f7f84
BLAKE2b-256 1bbabfef3fc43061d8b132af1876ab184d6f5938f83727f9befd7c72a16e3760

See more details on using hashes here.

Provenance

The following attestation bundles were made for pymobiledevice3-9.12.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