CONTRIBUTING.md

Contributing to adb-updater

Workflow

1. clone this repository

   git clone --recurse-submodules 'https://github.com/Microeinstein/adb-updater.git'
   # or
   git clone --recurse-submodules 'git@github.com:Microeinstein/adb-updater.git'

Local machine (posix)

2. build the lister helper

3. create a virtual environment (recommended);
   I suggest using an env which supports native packages other than pip ones, like miniconda

   conda create -p './venv'
   conda activate './venv'
   conda install  python=3.10  libpython-static=3.10
   pip install -r 'requirements.txt'
   pip install pyinstaller

4. do your hacking on your favorite IDE/editor;
   I personally use VSCodium _{with ms extensions} for the whole project

5. build the project

   # check the script for other flags
   bash build.sh;  # --clean --onefile

6. run the project

   bash build.sh  run
   # or
   export PYTHONPATH="./src"
   python -m adb_updater;  # ...

Local machine (Windows)

It is suggested to use bash from Git for Windows, which is taken from MSYS2;
last (un)official working versions for Windows 7:

• Git for Windows — v2.46.0.windows.1
• Python 3.10 — custom fork
  • cryptography==41.0.0

---

2. build the lister helper

Docker

The current Dockerfile makes use of

• archlinux image + AUR for Android SDK and lister building,
• python:3.10.12-slim-buster image for project building,
• debian:buster-slim for project running.

A new adbkey will be generated at the last layer.

2. build all

   # install: docker  docker-buildx
   docker --debug  build -t adb-updater  '.'

3. run the project

   # connect your device and check for the usb path
   lsusb
   docker run -it --device=/dev/bus/usb/BUS/DEV  adb-updater:latest