Files
android-assistant/CLAUDE.md
T

4.5 KiB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

A Python GUI tool for managing Android device files via ADB (Android Debug Bridge). The application automatically downloads ADB platform-tools if needed, detects connected devices, and provides a Tkinter-based interface for transferring files between Android devices and local systems.

Supported Platforms: Windows, Linux (Debian, Arch, RHEL/Fedora)

Development Setup

Installation

poetry install

Running the Application

poetry run python -m src.main

Common Commands

Testing


# Test if application runs
poetry run python -m src.main

# Run all tests
poetry run pytest tests/ -v

# Run tests with coverage
poetry run pytest tests/ -v --cov

# Run specific test file
poetry run pytest tests/core/test_adb_manager.py -v

Code Quality

# Format code with Black
poetry run black src/ tests/

# Lint with flake8
poetry run flake8 src/ tests/

# Type checking with mypy
poetry run mypy src/

Building and Packaging

Local Development Build (Linux)

poetry run python scripts/build_package_linux.py

Platform-Specific Builds

# Windows executable (PyInstaller)
poetry run pyinstaller scripts/spec_scripts/android-file-handler-windows.spec

# Linux packages use distro-specific spec files:
# - android-file-handler-debian.spec
# - android-file-handler-arch.spec
# - android-file-handler-rhel.spec

Architecture

Directory Structure

  • src/core/: Core ADB functionality

    • adb_manager.py: Main ADB interface and operations coordinator
    • adb_command.py: Command execution wrapper
    • file_transfer.py: File transfer logic
    • platform_tools.py: ADB binary management and download
    • platform_utils.py: Platform detection utilities
    • progress_tracker.py: Transfer progress tracking
  • src/gui/: GUI components

    • main_window.py: Main application window (entry point for GUI)
    • components/: Reusable UI widgets (file browser, path selectors, etc.)
    • handlers/: Event and animation handlers
    • dialogs/: Dialog windows (license agreement, device instructions, etc.)
  • src/managers/: Business logic coordination

    • device_manager.py: Device detection and management
    • transfer_manager.py: Coordinates transfers between GUI and ADB manager
  • src/utils/: Utility modules

    • file_deduplication.py: File deduplication logic
  • scripts/: Build and packaging scripts

    • build_package_linux.py: Unified Linux packaging script (uses DISTRO_TYPE env var)
    • spec_scripts/: PyInstaller spec files for each platform
  • tests/: Test suite mirroring src/ structure

Application Flow

  1. Startup: src/main.py → License check → gui/main_window.py:main()
  2. ADB Setup: ADBManager checks for platform-tools, downloads if needed
  3. Device Detection: DeviceManager checks for connected devices
  4. File Transfer: TransferManager coordinates UI updates with ADB file operations

Key Patterns

  • Import Fallbacks: Most modules use try/except for relative vs. direct imports to support both module and direct execution
  • Manager Pattern: Business logic separated into DeviceManager, TransferManager, ADBManager
  • Component Composition: GUI built from reusable components in gui/components/
  • Threading: File transfers run in background threads; UI updates via callbacks

CI/CD

The project uses GitHub Actions for multi-platform builds (.github/workflows/release.yml):

  • Runs tests on Linux and Windows
  • Builds binaries for Windows, Debian, Arch, and RHEL
  • Packages using PyInstaller + fpm
  • Supports manual workflow dispatch with configurable jobs
  • Optional GitHub release creation and S3 upload

Coding Standards

  • Follow PEP 8 guidelines
  • Use type hints for all function parameters and return values
  • Write docstrings for all public modules, functions, and classes
  • Use f-strings for string formatting
  • No single-letter variable names except e for exceptions
  • Always run Python commands through Poetry
  • Do not recreate deleted files
  • Do not change user-facing text unless asked
  • Always run the application to test if it will run and have it run successfully before declaring an iteration complete

Notes

  • ADB Binaries: Stored in src/platform-tools/ - do not modify or delete
  • Python Version: Requires Python 3.12 (< 3.13)
  • Package Mode: Poetry is configured with package-mode = false
  • License: First-run license agreement required on Windows