Plyer is a platform-independent Python wrapper for platform-dependent APIs
Python HTML Makefile
Clone or download
Latest commit b68d19f Jul 11, 2018

README.rst

Plyer

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

coverage travis appveyor

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 X X   X X
Barometer X X      
Audio recording X        
Battery X X X X X
Bluetooth          
Brightness X X     X
Call X X      
Camera (taking picture) X X      
Compass X X      
Email (open mail client) X X X X X
Flash X X      
GPS X X      
Gravity X X      
IR Blaster X        
Notifications X   X X X
Text to speech X X X X X
Email (open mail client) X X X X X
Vibrator X X      
Sms (send messages) X X      
Compass X X      
Unique ID X X X X X
Gyroscope X X      
IR Blaster X        
Light X        
Native file chooser     X X X
Orientation X        
Proximity X        
Humidity X        
Sms (send messages) X X      
Spatial Orientation X X      
Storage Path X X X X  
Temperature X        
Text to speech X X X X X
Unique ID X X X X X
Vibrator X X      
Wifi     X X X
Number of Processors         X

Support

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

We also have an IRC channel:

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

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.