Plyer is a platform-independent api to use features commonly found on various platforms, notably mobile ones, in Python.
Plyer tries not to reinvent the wheel, and will call for external libraries to implement the api in the easiest way, depending on the current platform.
- on python-for-android, pyjnius is used
- on kivy-ios, pyobjus is used
- on windows/mac/linux, commonly found libraries and programs will be used
| Platform | Android | iOS | Windows | OS X | Linux |
|---|---|---|---|---|---|
| Accelerometer | ✔ | ✔ | ✔ | ✔ | |
| Audio recording | ✔ | ✔ | ✔ | ||
| Barometer | ✔ | ✔ | |||
| Battery | ✔ | ✔ | ✔ | ✔ | ✔ |
| Bluetooth | ✔ | ✔ | |||
| Brightness | ✔ | ✔ | ✔ | ||
| Call | ✔ | ✔ | |||
| Camera (taking picture) | ✔ | ✔ | |||
| Compass | ✔ | ✔ | |||
| CPU count | ✔ | ✔ | ✔ | ||
| Devicename | ✔ | ✔ | ✔ | ✔ | |
| Email (open mail client) | ✔ | ✔ | ✔ | ✔ | ✔ |
| Flash | ✔ | ✔ | |||
| GPS | ✔ | ✔ | |||
| Gravity | ✔ | ✔ | |||
| Gyroscope | ✔ | ✔ | |||
| Humidity | ✔ | ||||
| IR Blaster | ✔ | ||||
| Light | ✔ | ||||
| Native file chooser | ✔ | ✔ | ✔ | ✔ | |
| Notifications | ✔ | ✔ | ✔ | ✔ | |
| Orientation | ✔ | ||||
| Proximity | ✔ | ||||
| Screenshot | ✔ | ✔ | ✔ | ||
| SMS (send messages) | ✔ | ✔ | |||
| Spatial Orientation | ✔ | ✔ | |||
| Speech to text | ✔ | ||||
| Storage Path | ✔ | ✔ | ✔ | ✔ | ✔ |
| Temperature | ✔ | ||||
| Text to speech | ✔ | ✔ | ✔ | ✔ | ✔ |
| Unique ID | ✔ | ✔ | ✔ | ✔ | ✔ |
| Vibrator | ✔ | ✔ | |||
| Wifi | ✔ | ✔ | ✔ |
To use on desktop: pip install plyer
To use in python-for-android/kivy-ios: add plyer to your requirements if needed.
If you need assistance, you can ask for help on our mailing list:
- User Group : https://groups.google.com/group/kivy-users
- Email : kivy-users@googlegroups.com
Discord channel:
- Server : https://chat.kivy.org
- Channel : #dev
We love pull requests and discussing novel ideas. Check out our contribution guide and feel free to improve Plyer.
The following mailing list and IRC channel are used exclusively for discussions about developing the Kivy framework and its sister projects:
- Dev Group : https://groups.google.com/group/kivy-dev
- Email : kivy-dev@googlegroups.com
IRC channel:
- Server : irc.freenode.net
- Port : 6667, 6697 (SSL only)
- Channel : #kivy-dev
Plyer is released under the terms of the MIT License. Please refer to the LICENSE file.
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
