Plyer is a platform-independent Python wrapper for platform-dependent APIs
Branch: master
Clone or download

README.md

Plyer

Plyer is a platform-independent api to use features commonly found on various platforms, notably mobile ones, in Python.

coverage travis appveyor Backers on Open Collective Sponsors on Open Collective

How

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

Supported APIs

Platform Android iOS Windows OS X Linux
Accelerometer
Audio recording
Barometer
Battery
Bluetooth
Brightness
Call
Camera (taking picture)
Compass
CPU count
Email (open mail client)
Flash
GPS
Gravity
Gyroscope
Humidity
IR Blaster
Light
Native file chooser
Notifications
Orientation
Proximity
Screenshot
SMS (send messages)
Spatial Orientation
Speed to text
Storage Path
Temperature
Text to speech
Unique ID
Vibrator
Wifi

Support

If you need assistance, you can ask for help on our mailing list:

Discord channel:

Contributing

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:

IRC channel:

  • Server : irc.freenode.net
  • Port : 6667, 6697 (SSL only)
  • Channel : #kivy-dev

License

Plyer is released under the terms of the MIT License. Please refer to the LICENSE file.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]