Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 2.87 KB

README.md

File metadata and controls

59 lines (45 loc) · 2.87 KB
Raw

⛏️ apkfile • Python library for handling APK, APKM, XAPK, and APKS files

CodeFactor PyPI Downloads PyPI Version

Install with pip

pip3 install -U apkfile

Or, install from source:

git clone https://github.com/david-lev/apkfile.git
cd apkfile
python3 setup.py install

You also need to install aapt (see Install aapt below).

Usage

from apkfile import ApkFile, XapkFile, ApkmFile, ApksFile

# Get apk info
apk_file = ApkFile(path='/home/david/Downloads/wa.apk')
print(apk_file.package_name, apk_file.version_name, apk_file.version_code)
print(apk_file.as_dict())

# Get apkm info
apkm_file = ApkmFile('/home/david/Downloads/chrome.apkm')
for split in apkm_file.splits:
    print(split.split_name)
apkm_file.install(check=True, upgrade=True)

# Using context manager (delete the extracted files when done)
with XapkFile(path='/home/david/Downloads/telegram.xapk') as xf:
    print(xf.base.abis, x.permissions, x.langs)

# Get apks info
apks_file = ApksFile(path='/home/david/Downloads/facebook.apks')
print(apks_file.base.permissions, apks_file.md5, apks_file.sha256)

How this library works?

This library uses aapt to extract information from the .APK file, and then parses the output to get the information.

  • For the zip files (.APKM, .XAPK, and .APKS), the basic information (package_name, version_name, version_code, etc.) is derived from the .json file, and the rest of the information is extracted when it requested (lazy evaluation).
  • The library also provide ways to install the files (and check compatibility; min_sdk_version, abis and langs) using adb. Just connect your device/s and run the install method. (you can use the install_apks function independently).

Install aapt

apkfile requires aapt to be in the PATH. In each operating system, the way to install aapt is different, if you installed Android Studio, add one of the build-tools paths to the PATH, if you are on a Debian-based Linux system (Ubuntu etc.) you can install with sudo apt install aapt, and on Windows and Mac? Just google "How to install aapt on X".

  • You can manually provide a path to aapt: ApkFile(..., aapt_path='/path/to/aapt').

Install adb

if you want to use the install method, you need to install adb.

  • You can manually provide a path to adb: ApkFile(...).install(adb_path='/path/to/adb').