Merge branch 'main' into main

Author: tsterbak

.github/ISSUE_TEMPLATE/device-support-request.yaml

@@ -85,5 +85,5 @@ body:
   - type: textarea
     attributes:
       label: Additional context
-      description: Please provide any additional context or information that might be helpful in adding support for this device. 
+      description: Please provide any additional context or information that might be helpful in adding support for this device.
       render: Markdown

.github/workflows/build-release.yml

@@ -17,13 +17,14 @@ jobs:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.11
     - run: pip install -r requirements.txt
     - run: python scripts/download-tools.py
+    - run: pip install black ruff pytest pytest-cov pytest-mock pytest-subprocess
     - run: black .
     - run: ruff openandroidinstaller/ --ignore E501
     - run: PYTHONPATH=openandroidinstaller:$(PYTHONPATH) pytest --cov=openandroidinstaller tests/
-    
+
   build:
     needs: ci
     runs-on: ${{ matrix.os }}
@@ -35,31 +36,31 @@ jobs:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.11
     - run: pip install -r requirements.txt
     - run: python scripts/download-tools.py
     - run: python scripts/build.py
     - uses: actions/upload-artifact@v3
       with:
         name: openandroidinstaller-${{  github.ref_name }}-${{ matrix.os }}
         path: dist/
-  
+
   build-windows:
     needs: ci
     runs-on: 'windows-latest'
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.11
     - run: pip install -r requirements.txt
     - run: python scripts/download-tools.py
     - run: python scripts/build.py
     - uses: actions/upload-artifact@v3
       with:
         name: openandroidinstaller-${{  github.ref_name }}-windows-latest
         path: dist/
-  
+
   create-release:
     needs:
       - build

.gitignore

@@ -5,24 +5,24 @@ __pycache__
 *.py[cod]
 *$py.class
 
-# Distribution / packaging 
-.Python build/ 
-develop-eggs/ 
-dist/ 
-downloads/ 
-eggs/ 
-.eggs/ 
-lib/ 
-lib64/ 
-parts/ 
-sdist/ 
-var/ 
-wheels/ 
-*.egg-info/ 
-.installed.cfg 
-*.egg 
-*.manifest 
-*.spec 
+# Distribution / packaging
+.Python build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+*.manifest
+*.spec
 heimdall/
 libusb-windows/
 openandroidinstaller/bin/
@@ -33,17 +33,17 @@ pip-log.txt
 pip-delete-this-directory.txt
 *.log
 
-# Unit test / coverage reports 
-htmlcov/ 
-.tox/ 
-.coverage 
-.coverage.* 
-.cache 
-.pytest_cache/ 
-nosetests.xml 
-coverage.xml 
-*.cover 
-.hypothesis/ 
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
 
 # Translations
 *.mo
@@ -72,42 +72,42 @@ env/
 venv/
 ENV/
 
-# If you are using PyCharm # 
-.idea/**/workspace.xml 
-.idea/**/tasks.xml 
-.idea/dictionaries 
-.idea/**/dataSources/ 
-.idea/**/dataSources.ids 
-.idea/**/dataSources.xml 
-.idea/**/dataSources.local.xml 
-.idea/**/sqlDataSources.xml 
-.idea/**/dynamic.xml 
-.idea/**/uiDesigner.xml 
-.idea/**/gradle.xml 
-.idea/**/libraries 
-*.iws /out/ 
+# If you are using PyCharm #
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/gradle.xml
+.idea/**/libraries
+*.iws /out/
 
 # Sublime Text
-*.tmlanguage.cache 
-*.tmPreferences.cache 
-*.stTheme.cache 
-*.sublime-workspace 
-*.sublime-project 
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+*.sublime-workspace
+*.sublime-project
 
-# sftp configuration file 
+# sftp configuration file
 sftp-config.json
 
-# Package control specific files Package 
-Control.last-run 
-Control.ca-list 
-Control.ca-bundle 
-Control.system-ca-bundle 
-GitHub.sublime-settings 
+# Package control specific files Package
+Control.last-run
+Control.ca-list
+Control.ca-bundle
+Control.system-ca-bundle
+GitHub.sublime-settings
 
-# Visual Studio Code # 
-.vscode/* 
-!.vscode/settings.json 
-!.vscode/tasks.json 
-!.vscode/launch.json 
-!.vscode/extensions.json 
+# Visual Studio Code #
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
 .history

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+fail_fast: true
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-ast
+    -   id: check-merge-conflict
+    -   id: check-yaml
+    -   id: detect-private-key
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+        language_version: python3.10
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ '--ignore', 'E501', '--fix' ]
+      # Run the formatter.
+      - id: ruff-format
+
+-   repo: https://github.com/python-poetry/poetry
+    rev: 1.6.1
+    hooks:
+    -   id: poetry-check
+    #-   id: poetry-lock
+    -   id: poetry-export
+    #-   id: poetry-install

CODE_OF_CONDUCT.md

@@ -119,11 +119,11 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
 [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
 
-Community Impact Guidelines were inspired by 
+Community Impact Guidelines were inspired by
 [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
 at [https://www.contributor-covenant.org/translations][translations].
 
 [homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to the OpenAndroidInstaller project 
+# Contributing to the OpenAndroidInstaller project
 
 💖 First of all: thank you for contributing to the OpenAndroidInstaller! Great that you are here!
 

Makefile

@@ -1,9 +1,24 @@
+.phoney: install export format lint typing test app test-app build-app clean-build
+
+help:
+	@echo "install - install dependencies"
+	@echo "export - export dependencies to requirements.txt"
+	@echo "format - format code with black"
+	@echo "lint - lint code with ruff"
+	@echo "typing - type check code with mypy"
+	@echo "test - run tests"
+	@echo "app - run app"
+	@echo "test-app - run app in test mode with test config for sargo"
+	@echo "build-app - build app"
+	@echo "clean-build - clean build"
+
 poetry:
 	curl -sSL https://install.python-poetry.org | python3 -
 
 install:
-	poetry install
+	poetry install --with dev
 	poetry run python scripts/download-tools.py
+	poetry run pre-commit install
 
 export:
 	poetry export -f requirements.txt --output requirements.txt