Plyer is a platform-independent Python API for accessing hardware features of various platforms (Android, iOS, macOS, Linux and Windows).
Plyer is managed by the Kivy Team. It is suitable for use with Kivy apps, but can be used independently.
Plyer tries not to reinvent the wheel, and will call external libraries to implement the API in the easiest way, depending on the current platform.
- On Android (python-for-android), PyJNIus is used.
- On iOS (kivy-ios) and macOS, pyobjus is used.
- On Windows, macOS and Linux, other commonly found libraries and programs are used.
| Platform | Android | iOS | Windows | macOS | 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 | ✔ | ||||
| Keystore | ✔ | ✔ | ✔ | ✔ | ✔ |
| Light | ✔ | ||||
| Maps | ✔ | ✔ | |||
| 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 | ✔ | ✔ | ✔ |
Full documentation, including details about the API, is available online. If you are not using the latest version of Plyer, earlier versions of the documentations are linked from there.
To use on desktop: pip install plyer
To use in python-for-android and Kivy for iOS, add plyer to your requirements
if needed.
Plyer is MIT licensed, actively developed by a great community and is supported by many projects managed by the Kivy Organization.
Are you having trouble using Plyer or any of its related projects in the Kivy ecosystem? Is there an error you don’t understand? Are you trying to figure out how to use it? We have volunteers who can help!
The best channels to contact us for support are listed in the latest Contact Us document.
Plyer is part of the Kivy ecosystem - a large group of products used by many thousands of developers for free, but it is built entirely by the contributions of volunteers. We welcome (and rely on) users who want to give back to the community by contributing to the project.
Contributions can come in many forms. See the latest Contribution Guidelines for how you can help us.
In the interest of fostering an open and welcoming community, we as contributors and maintainers need to ensure participation in our project and our sister projects is a harassment-free and positive experience for everyone. It is vital that all interaction is conducted in a manner conveying respect, open-mindedness and gratitude.
Please consult the latest Code of Conduct.
This project exists thanks to all the people who contribute. [Become a contributor].
Thank you to all of our backers! 🙏 [Become a backer]
Special thanks to all of our sponsors, past and present. Support this project by [becoming a sponsor].
Here are our top current sponsors. Please click through to see their websites, and support them as they support us.
