Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/postlund/pyatv
A client library for Apple TV and AirPlay devices
https://github.com/postlund/pyatv
airplay apple-tv asyncio hacktoberfest home-automation pypi python3 raop
Last synced: 3 days ago
JSON representation
A client library for Apple TV and AirPlay devices
- Host: GitHub
- URL: https://github.com/postlund/pyatv
- Owner: postlund
- License: mit
- Created: 2017-02-01T11:30:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-24T04:14:33.000Z (19 days ago)
- Last Synced: 2024-12-25T22:02:07.933Z (17 days ago)
- Topics: airplay, apple-tv, asyncio, hacktoberfest, home-automation, pypi, python3, raop
- Language: Python
- Homepage: https://pyatv.dev
- Size: 7.1 MB
- Stars: 904
- Watchers: 27
- Forks: 101
- Open Issues: 188
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Support: docs/support/acknowledgements.md
Awesome Lists containing this project
- awesome-engineering - PyATV
- awesome-engineering - PyATV
README
A client library for Apple TV and AirPlay devices
=================================================
[](https://codecov.io/gh/postlund/pyatv)
[](https://github.com/psf/black)
[](https://badge.fury.io/py/pyatv)
[](https://gitpod.io/#https://github.com/postlund/pyatv)
[](https://pepy.tech/project/pyatv)
[](https://pypi.python.org/pypi/pyatv/)
[](https://opensource.org/licenses/MIT)
This is an asyncio python library for interacting with Apple TV and AirPlay devices. It mainly
targets Apple TVs (all generations, **including tvOS 15 and later**), but also supports audio streaming via AirPlay
to receivers like the HomePod, AirPort Express and third-party speakers. It can act as remote control to the Music
app/iTunes in macOS.
All the documentation you need is available at **[pyatv.dev](https://pyatv.dev)**.
# What can it do?
Some examples include:
* Remote control commands
* Metadata retrieval with push updates
* Stream files via AirPlay
* List and launch installed apps
* List and switch user accounts
* Add, remove or set audio output devices (e.g. HomePods)
* Keyboard support
* Persistent storage of credentials and settings
...and lots more! A complete list is available [here](https://pyatv.dev/documentation/supported_features/).
# Great, but how do I use it?
All documentation (especially for developers) are available at [pyatv.dev](https://pyatv.dev).
It is however possible to install with `pip` and set up a new device `atvremote`:
```raw
$ pip install pyatv
$ atvremote wizard
Looking for devices...
Found the following devices:
Name Model Address
-- ------------------------ ----------------------- -----------
1 Receiver+ airupnp 10.0.10.200
2 Receiver RX-V773 10.0.10.82
3 Pierre's AirPort Express AirPort Express (gen 2) 10.0.10.168
4 FakeATV Unknown 10.0.10.254
5 Vardagsrum Apple TV 4K 10.0.10.81
6 Apple TV Apple TV 3 10.0.10.83
Enter index of device to set up (q to quit): 4
Starting to set up FakeATV
Starting to pair Protocol.MRP
Enter PIN on screen: 1111
Successfully paired Protocol.MRP, moving on...
Pairing finished, trying to connect and get some metadata...
Currently playing:
Media type: Music
Device state: Playing
Title: Never Gonna Give You Up
Artist: Rick Astley
Position: 1/213s (0.0%)
Repeat: Off
Shuffle: Off
Device is now set up!
```
After setting up a new device, other commands can be run directly:
```raw
$ atvremote -s 10.0.10.254 playing
Media type: Music
Device state: Playing
Title: Never Gonna Give You Up
Artist: Rick Astley
Position: 1/213s (0.0%)
Repeat: Off
Shuffle: Off
$ atvremote -s 10.0.10.254 pause
$ atvremote -n FakeATV play
```
You can also run it inside a container (x86_64, aarch64, armv7):
```raw
docker run -it --rm --network=host ghcr.io/postlund/pyatv:0.14.0 atvremote scan
```
The `master` tag points to latest commit on the `master` branch and `latest`
points to the latest release.
# I need to change something?
Want to help out with `pyatv`? Press the button below to get a fully prepared development environment and get started right away!
[](https://gitpod.io/#https://github.com/postlund/pyatv)
# Shortcuts to the good stuff
To save you some time, here are some shortcuts:
* [Getting started](https://pyatv.dev/documentation/getting-started/)
* [Documentation](https://pyatv.dev/documentation)
* [Development](https://pyatv.dev/development)
* [API Reference](https://pyatv.dev/api)
* [Support](https://pyatv.dev/support)