android_manager/README.md

# android_manager

Do backups and restores of apps installed in your Android phone via the Android USB Debug

## Requirements

1. Enable Android USB debug.

   1. In your Android phone, go to Settings

   2. Go to "About phone"

   3. Click repeatedly over "Build number", you might get ask for confirmation with your security protection (pin, password, fingerprint, face, ...)

   4. Go to "System"

   5. Go to "Developer options"

   6. Enable "USB  debbuging"

2. Connect your phone via USB to your computer

## Installation

### Linux

To install for example in your ~/.local/bin folder:

```bash
./install.sh --destination ~/.local/bin
```

To install system-wide:

```bash
sudo ./install.sh --destination /usr/local/bin
```

Change your configuration file in "${HOME}/.config/android_manager.conf" (see the example in the config folder).

### Windows (from PowerShell)

Ensure you have "C:\Users\${env:USERNAME}\AppData\Roaming\Python\Python${python_version}\Scripts\" in your Path environment variable.

  ```powershell
  & $(where.exe pip).split()[0] install .
```

## Usage

```bash
android_manager.py [OPTIONS] COMMAND [ARGS]
```

### General options

|short|long|parameter|description|
|--|--|--|--|
|-d| --debug-level|critical, error, warning, info, debug, notset |Set the debug level for the standard output.|
|-l| --log-file|TEXT             |File to store all debug messages.|
|-f| --cache-file|TEXT           |Cache file to store data from each run|
|-a| --max-cache-age|INTEGER     |Max age in seconds for the cache|
|-H| --host|TEXT                 |ADB server host name or IP.|
|-p| --port|INTEGER              |ADB server port to use.|
||--config|FILE                   |Read configuration from FILE.|
||--help|                          |Show this message and exit.|

### Commands

#### Backup Android apps: backup-apps

##### Backup apps options

|short|long|parameter|description|
|--|--|--|--|
|-p|--backup-path|TEXT|  Path to save the backed APKs  [required]|
|-n|--just-names||        Save only the filename|
||--config| FILE|           Read configuration from FILE.|
||--help||                  Show this message and exit.|

#### Restore Android apps: restore-apps

##### Restore apps options

|short|long|parameter|description|
|--|--|--|--|
|-p|--backup-text-file |TEXT|     Path to save the backed APKs  [required]|
|-n|--device-product-name| TEXT|  Device product name to install the apps. If not indicated it will install in the first device found.|
||--config| FILE                |   Read configuration from FILE.|
||--help||                          Show this message and exit.|