Metadata-Version: 2.4
Name: dumpyara
Version: 1.1.0
Summary: Android firmware extractor
License: GPL-3.0-or-later
License-File: LICENSES/GPL-3.0-or-later.txt
License-File: LICENSES/MIT.txt
Author: Sebastiano Barezzi
Author-email: seba@sebaubuntu.dev
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
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.14
Requires-Dist: Brotli (>=1.0.9,<2.0.0)
Requires-Dist: liblp (>=1.0.2,<2.0.0)
Requires-Dist: lz4 (>=4.3.3,<5.0.0)
Requires-Dist: protobuf (>=4.22.1,<7.0.0)
Requires-Dist: py7zr (>=1.0.0,<2.0.0)
Requires-Dist: sebaubuntu-libs (>=2.0.0,<3.0.0)
Requires-Dist: zstandard (>=0.23,<0.26)
Project-URL: Repository, https://github.com/sebaubuntu-python/dumpyara
Description-Content-Type: text/markdown

# dumpyara

[![PyPI version](https://img.shields.io/pypi/v/dumpyara)](https://pypi.org/project/dumpyara/)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/85d2c39edbed4dc38f680db01f7b83af)](https://app.codacy.com/gh/sebaubuntu-python/dumpyara/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

Requires Python 3.9 or greater

## Installation

```sh
pip install dumpyara
```

## Instructions

```sh
python -m dumpyara <path to OTA file>
```

## Supported formats

### Step 1 - Archives

- All the ones supported by shutil's extract_archive
- Samsung's `.tar.md5` archives
- Nested archives
- LG's `.kdz` archives

### Step 2 - What's inside the archive

- A-only OTAs (Brotli and/or sdat compressed)
- A/B OTAs
- Dynamic partitions (super.img)
- payload.bin
- Raw images (e.g. Xiaomi fastboot packages)
- Sparse images
- LZ4 images

### Step 3 - Partition images

- Android boot images
- 7z supported archives/images
- EROFS images using erofs-utils

## Credits

- AIK: osm0sis
- [extract_android_ota_payload](https://github.com/erfanoabdi/extract_android_ota_payload): cyxx and erfanoabdi
- sdat2img: xpirt

## License

```
#
# SPDX-FileCopyrightText: Dumpyara Project
# SPDX-License-Identifier: GPL-3.0-or-later
#
```

