Metadata-Version: 2.2
Name: adbnik
Version: 0.7.4
Summary: Adbnik — ADB device workspace: shell, APK install, SSH, serial, files, USB screen (PyQt5 desktop).
Author: Adbnik contributors
License: MIT License
        
        Copyright (c) 2026 Adbnik contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://nvnkennedy.github.io/adbnik/
Project-URL: Repository, https://github.com/nvnkennedy/adbnik
Project-URL: Documentation, https://github.com/nvnkennedy/adbnik#readme
Project-URL: PyPI, https://pypi.org/project/adbnik/
Keywords: android,adb,apk,ssh,serial,scrcpy,pyqt5,sftp,desktop,screen-mirroring
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: X11 Applications :: Qt
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt5<6.0,>=5.15.11
Requires-Dist: pyserial<4.0,>=3.5
Requires-Dist: paramiko<5.0,>=3.0
Requires-Dist: qt-thread-updater<2,>=1.1
Requires-Dist: QtPy<3,>=2.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Provides-Extra: build
Requires-Dist: pyinstaller<7.0,>=6.0; extra == "build"

# Adbnik

  Adbnik logo

**Adbnik** is a PyQt5 desktop app for Android and remote workflows: **ADB** shells and shortcuts, **SSH** terminals, **serial** consoles, **file transfer** (device, SFTP, FTP), and launching **screen mirroring** (e.g. scrcpy) from one tabbed window.

Third-party tools (**adb**, **ssh**, **scrcpy**) are **not** bundled—install them separately and point to them in **File → Preferences** if they are not on your `PATH`.

---

## Features

| Area | What you get |
|------|----------------|
| **ADB** | Device list, shell tabs, APK install flow, bookmarks, quick commands |
| **SSH** | Full-screen terminal using your system OpenSSH client |
| **Serial** | COM port + baud in the UI |
| **Files** | Local ↔ remote browser (Android / SFTP / FTP) |
| **Screen** | Start and manage mirroring with your chosen executable |

---

## Requirements

- **Python 3.9+** (64-bit recommended on Windows)
- **Android:** USB debugging; **platform-tools** (`adb`) available to that Python environment
- **SSH:** `ssh` on `PATH` (or configured the same way your shell finds it)
- **Mirroring:** `scrcpy` or another tool, on `PATH` or set in Preferences
- **Serial:** Port visible to the OS with a suitable driver

---

## Install

Use one Python interpreter for both **pip** and **launch** (avoids broken entry points on Windows):

```bat
py -m pip install --upgrade pip
py -m pip install adbnik
py -m adbnik
```

With a specific interpreter:

```bat
"C:\Path\To\Python\python.exe" -m pip install adbnik
"C:\Path\To\Python\python.exe" -m adbnik
```

---

## First launch

1. Run **`python -m adbnik`** from the environment where the package is installed.
2. Set **ADB** / **scrcpy** paths under **File → Preferences** if needed.
3. Open the **Terminal**, **Files**, or **Screen** areas from the main tabs.

Configuration is stored in a **`.adbnik.json`** file under your user profile. Older **`.devicedeck.json`** settings are migrated when you save preferences.

---

## Screenshots

  Main window

  Terminal

  File explorer

  Screen control

---

## Development

```bat
git clone https://github.com/nvnkennedy/adbnik.git
cd adbnik
py -m venv .venv
.venv\Scripts\activate
py -m pip install -e ".[dev]"
py -m pytest tests -q
py -m adbnik
```

---

## Troubleshooting

**`ModuleNotFoundError: No module named 'adbnik'`** — Install with the same `python.exe` you use to run the app:

```bat
"C:\Path\To\Python\python.exe" -m pip install --force-reinstall adbnik
"C:\Path\To\Python\python.exe" -m adbnik
```

On Windows, list interpreters with **`py -0p`**.

---

## Links

| Resource | URL |
|----------|-----|
| Repository | https://github.com/nvnkennedy/adbnik |
| PyPI | https://pypi.org/project/adbnik/ |
| Site | https://nvnkennedy.github.io/adbnik/ |

---

## License

MIT — see [LICENSE](LICENSE).
