Change repository name to adb-pywrapper

.github/workflows/publish.yml

@@ -49,7 +49,7 @@ jobs:
       # Add your build/test steps here
       - name: Run Tests
         working-directory: test
-        run: python test_adb_py.py
+        run: python adb-pywrapper.py
         env:
           PYTHONPATH: ${{ steps.modify-sys-path.outputs.sys-path }}
 

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
       # Add your build/test steps here
       - name: Run Tests
         working-directory: test
-        run: python test_adb_py.py
+        run: python adb-pywrapper.py
         env:
           PYTHONPATH: ${{ steps.modify-sys-path.outputs.sys-path }}
 

.gitignore

@@ -1,4 +1,4 @@
-adb_py.egg-info
+*egg-info
 build
 venv
 dist

README.md

@@ -1,21 +1,23 @@
-# adb_py Documentation
+# adb-pywrapper
+A python wrapper for the Android Debug Bridge enabling interaction with Android devices and emulators.
+
+<img src="adb-pywrapper_logo.jpg" alt="adb-pywrapper logo" width="500"/>
 
-<img src="adb_py_logo.jpg" alt="adb_py logo" width="500"/>
 
 ## AdbDevice: Interacting with Android Devices using ADB in Python
 
-The `AdbDevice` class in the `adb_py` Python package facilitates seamless interaction with Android devices using the Android Debug Bridge (ADB) directly within Python scripts.
+The `AdbDevice` class in the `adb-pywrapper` Python package facilitates seamless interaction with Android devices using the Android Debug Bridge (ADB) directly within Python scripts.
 
 Installation
 ------------
 
-To install the `adb_py` package from the internal nexus pipy server, you can use `pip`:
+To install the `adb-pywrapper` package from the internal nexus pipy server, you can use `pip`:
 
 ```bash
-pip install adb_py
+pip install adb-pywrapper
 ```
 
-Before using `adb_py`, ensure that ADB is installed on your machine and added to PATH. You can download and install the Android SDK, which includes ADB, from the official Android developer website.
+Before using `adb-pywrapper`, ensure that ADB is installed on your machine and added to PATH. You can download and install the Android SDK, which includes ADB, from the official Android developer website.
 
 If running the below in a terminal gives you an output, you are ready to go!
 
@@ -28,7 +30,7 @@ adb --version
 Import the necessary modules:
 
 ```python
-from adb_py import AdbDevice, AdbResult, PullResult
+from adb-pywrapper import AdbDevice, AdbResult, PullResult
 ```
 
 ## Listing Connected Devices
@@ -191,7 +193,7 @@ ls(path)
 * snapshot_delete(delete=None)  
 
 ## Error Handling
-Be sure to handle errors gracefully in your code, as various operations may fail, adb_py tries to provide information where possible on success or failure in the `AdbResult` and `PullResult` objects.
+Be sure to handle errors gracefully in your code, as various operations may fail, adb-pywrapper tries to provide information where possible on success or failure in the `AdbResult` and `PullResult` objects.
 
 ## Contributing
-Contributions to the adb_py package are welcome. If you encounter any issues, have suggestions, or want to contribute, feel free to open an issue or PR.
+Contributions to the adb-pywrapper package are welcome. If you encounter any issues, have suggestions, or want to contribute, feel free to open an issue or PR.

setup.py

@@ -1,16 +1,16 @@
 from setuptools import setup
 
 setup(
-    name="adb_py",
+    name="adb-pywrapper",
     version="0.9",
-    description="adb_py facilitates seamless interaction with Android devices using the Android Debug Bridge (ADB) "
+    description="adb-pywrapper facilitates seamless interaction with Android devices using the Android Debug Bridge (ADB) "
                 "directly within Python scripts.",
     long_description=f"{open('README.md').read()}",
     long_description_content_type="text/markdown",
     author="Netherlands Forensic Institute",
     author_email="[email protected]",
-    url="https://github.com/NetherlandsForensicInstitute/adb_py",
+    url="https://github.com/NetherlandsForensicInstitute/adb-pywrapper",
     licence="EUPL-1.2",
-    py_modules=["adb_py", "adb_init"],
+    py_modules=["adb-pywrapper", "adb_init"],
     test_suite="test",
 )

test/test_adb_py.py → test/adb-pywrapper.py

@@ -5,7 +5,7 @@
 
 from parameterized import parameterized
 
-from adb_py import AdbResult, AdbDevice
+from adb_pywrapper import AdbResult, AdbDevice
 
 PROCESS = subprocess.run('echo hello', shell=True, capture_output=True)
 MOCK_SUCCESSFULLY_PULLED_FILE = ['abc.apk', 'bla.jpg']
@@ -321,7 +321,7 @@ def test_get_state(self):
         self.assertFalse(result.success)
         self.assertIn('Invalid command', result.stderr)
 
-    @patch('adb_py.AdbDevice._snapshot_command')
+    @patch('adb_pywrapper.AdbDevice._snapshot_command')
     def test_emulator_snapshots_list(self, mock_snapshot_command):
         # Test emulator_snapshots_list function
         snapshot_list_output = """List of snapshots present on all disks:
@@ -336,8 +336,8 @@ def test_emulator_snapshots_list(self, mock_snapshot_command):
         mock_snapshot_command.assert_called_once_with('list')
         self.assertEqual(result, ['snap_2023-11-23_13-13-02', 'snap_2023-12-05_12-56-56'])
 
-    @patch('adb_py.AdbDevice._snapshot_exists')
-    @patch('adb_py.AdbDevice._snapshot_command')
+    @patch('adb_pywrapper.AdbDevice._snapshot_exists')
+    @patch('adb_pywrapper.AdbDevice._snapshot_command')
     def test_emulator_snapshot_load_existing(self, mock_snapshot_command, mock_snapshot_exists):
         # Test emulator_snapshot_load function with an existing snapshot
         mock_snapshot_exists.return_value = True
@@ -348,7 +348,7 @@ def test_emulator_snapshot_load_existing(self, mock_snapshot_command, mock_snaps
         mock_snapshot_exists.assert_called_once_with('snapshot1')
         mock_snapshot_command.assert_called_once_with('load', 'snapshot1')
 
-    @patch('adb_py.AdbDevice._snapshot_exists')
+    @patch('adb_pywrapper.AdbDevice._snapshot_exists')
     def test_emulator_snapshot_load_non_existing(self, mock_snapshot_exists):
         # Test emulator_snapshot_load function with a non-existing snapshot
         mock_snapshot_exists.return_value = False
@@ -358,8 +358,8 @@ def test_emulator_snapshot_load_non_existing(self, mock_snapshot_exists):
         mock_snapshot_exists.assert_called_once_with('non_existing_snapshot')
         self.assertFalse(result.success)
 
-    @patch('adb_py.AdbDevice._snapshot_exists')
-    @patch('adb_py.AdbDevice._snapshot_command')
+    @patch('adb_pywrapper.AdbDevice._snapshot_exists')
+    @patch('adb_pywrapper.AdbDevice._snapshot_command')
     def test_emulator_snapshot_save(self, mock_snapshot_command, mock_snapshot_exists):
         # Test emulator_snapshot_save function
         mock_snapshot_exists.return_value = False
@@ -370,9 +370,9 @@ def test_emulator_snapshot_save(self, mock_snapshot_command, mock_snapshot_exist
         mock_snapshot_exists.assert_called_once_with('snapshot1')
         mock_snapshot_command.assert_called_once_with('save', 'snapshot1')
 
-    @patch('adb_py.AdbDevice.emulator_snapshots_list', return_value=['snapshot1', 'snapshot2'])
-    @patch('adb_py.AdbDevice._snapshot_exists')
-    @patch('adb_py.AdbDevice._snapshot_command')
+    @patch('adb_pywrapper.AdbDevice.emulator_snapshots_list', return_value=['snapshot1', 'snapshot2'])
+    @patch('adb_pywrapper.AdbDevice._snapshot_exists')
+    @patch('adb_pywrapper.AdbDevice._snapshot_command')
     def test_emulator_snapshot_delete(self, mock_snapshot_command, mock_snapshot_exists, mock_emulator_snapshots_list):
         # Test emulator_snapshot_delete function
         mock_snapshot_exists.return_value = True  # Existing snapshots