APK Utilities 2

1.0.0 verified Fri Apr 17 auth: no python

apkutils2 is a Python library designed for parsing and analyzing Android Package (APK) files. It offers functionalities to extract manifest information, package details, certificate data, and other resources. This library is a complete rewrite of the original `apkutils` and is currently at version 1.0.0, with an infrequent release cadence focusing on stability.

pip install apkutils2

Common errors

error FileNotFoundError: [Errno 2] No such file or directory: 'non_existent.apk' ↓

cause The APK file path provided to the `APK()` constructor does not exist on the file system.

fix

Ensure the path passed to APK() is correct and points to an existing .apk file. Use an absolute path or verify the current working directory.

error zipfile.BadZipFile: File is not a zip file ↓

cause The file provided to the `APK()` constructor is not a valid ZIP archive (APKs are essentially ZIP files). This usually means the file is corrupted, empty, or not actually an APK.

fix

Verify that the file at the given path is a legitimate, uncorrupted APK file. Try opening it with a standard ZIP utility if unsure.

error ImportError: cannot import name 'APK' from 'apkutils' ↓

cause You are attempting to import `APK` from the older `apkutils` library, but `apkutils2` is installed, or `apkutils2` is installed but you're trying to import using the old path.

fix

If you intend to use apkutils2, ensure your import statement is from apkutils2 import APK. If you need apkutils, install that library explicitly (pip install apkutils) and use its specific import paths.

Warnings

breaking apkutils2 is a complete rewrite and not an incremental upgrade from the original `apkutils` library. Existing code relying on `apkutils`'s API will not work with `apkutils2`. ↓

fix Rewrite code to use `apkutils2`'s new API and ensure imports are `from apkutils2 import APK`.

gotcha The `APK()` constructor expects a valid path to an actual, readable APK file. Passing a non-existent path or a non-APK file (e.g., an empty file or a text file) will lead to `FileNotFoundError`, `zipfile.BadZipFile`, or other parsing errors. ↓

fix Always verify that the path provided to `APK()` points to a legitimate `.apk` file that your program has read access to.

gotcha apkutils2 relies heavily on `androguard`, which can have complex dependencies or installation issues, particularly on certain operating systems or Python environments due to its low-level requirements. ↓

fix If `apkutils2` installation or execution fails, specifically investigate `androguard`'s documentation for system-level dependencies or compatibility notes, and try installing `androguard` directly first.

Imports

APK
wrong
```
from apkutils import APK
```
correct
```
from apkutils2 import APK
```
apkutils2 is a complete rewrite and has a different API and import path than the older apkutils library.

Quickstart

This quickstart demonstrates how to initialize the APK parser and extract basic information like package name, version, and manifest. It requires a valid APK file to be present at the specified path.

from pathlib import Path
from apkutils2 import APK

# IMPORTANT: Replace "path/to/your.apk" with the actual path to an Android APK file.
# You must have a valid .apk file to run this example.
apk_file_path = Path("path/to/your.apk") # e.g., Path("/home/user/my_app.apk")

try:
    if not apk_file_path.exists():
        raise FileNotFoundError(f"APK file not found: {apk_file_path}. "
                                "Please update 'apk_file_path' to a valid APK file.")

    apk = APK(str(apk_file_path)) # The constructor expects a string path

    print(f"Package Name: {apk.package_name}")
    print(f"Version Name: {apk.version_name}")
    print(f"Version Code: {apk.version_code}")
    print(f"Min SDK Version: {apk.get_min_sdk_version()}")

    # To get the full manifest XML:
    manifest_xml = apk.get_manifest().toprettyxml()
    print("\nManifest (first 200 chars):")
    print(manifest_xml[:200] + "...")

    # Example of getting certificate information
    certs = apk.get_certs()
    if certs:
        cert = certs[0] # Get the first certificate
        print(f"\nCertificate Subject: {cert.get_subject()}")
        print(f"Certificate Issuer: {cert.get_issuer()}")
    else:
        print("\nNo certificates found.")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Please ensure you have a valid APK file at the specified path.")