Metadata-Version: 2.1
Name: android-tv-remote
Version: 0.1.6
Summary: Provides a limited set of ADB commands. Primarly acts as a remote to control Android TV interfaces.
Author-email: Tim Santor <tsantor@xstudios.com>
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'

# Python Android TV Remote
Author:Tim Santor <tsantor@xstudios.com>

## Overview
Simple package that allows you to mimic Android TV remote inputs via Python.  Designed to be used over TCP (not USB).


## Features
Offers a limited set of ADB commands. See `src\androidtvremote\adb.py` for all commands.

    - `tcp`
    - `devices`
    - `connect`
    - `install`
    - `uninstall`
    - `push`
    - `pull`
    - `get-state`
    - `get-serialno`
    - `get-devpath`
    - `reboot`
    - `start-server`
    - `kill-server`

## Installation
To install python-android-tv-remote, simply:

    pip install android-tv-remote

## Tips
Get IP address:
```
adb devices
adb -s <DEVICE_ID> shell ip -f inet addr show wlan0
```

## Development

    make env
    make reqs
    pip install -e .

## Testing
Project is at **76%** test coverage.

    pytest -v
    tox

    # Run a specific test
    pytest -v tests/test_adb.py -k test_get_ip_address

    # Run coverage
    pytest --cov-report html --cov-report term --cov=tests/


## Documentation
Documentation is available at TODO


## Issues
If you experience any issues, please create an [issue](https://bitbucket.org/tsantor/python-android-tv-remote/issues) on Bitbucket.

# History
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).

## 0.1.6 (2023-06-22)
* New packaging method using `pyproject.toml`
* Added new tests

## 0.1.5 (2022-01-04)
* Ensure the ADB server is started as a background process during init.

## 0.1.4 (2021-12-12)
* Removed ADB `connect` params for `max_retries` and `retry_delay`.

## 0.1.3 (2021-12-10)
* Added ADB `connect` params for `max_retries` and `retry_delay`.

## 0.1.2 (2021-12-09)
* Added ADB disconnect method.
* Removed keycode constants from remote.py.  Can pass actual string constants to ADB.

## 0.1.1 (2021-12-08)
* Added KEYCODE_SOFT_SLEEP

## 0.1.0 (2019-04-25)
* First release on PyPI.
