An open API service indexing awesome lists of open source software.

https://github.com/keyweeusr/plyer

Fork of kivy/plyer. Plyer is a platform-independent Python wrapper for platform-dependent APIs
https://github.com/keyweeusr/plyer

android api-wrapper ios linux macos python windows

Last synced: 3 months ago
JSON representation

Fork of kivy/plyer. Plyer is a platform-independent Python wrapper for platform-dependent APIs

Awesome Lists containing this project

README

          

Plyer
=====

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

.. |coverage| image:: https://coveralls.io/repos/kivy/plyer/badge.svg?branch=master
:target: https://coveralls.io/r/kivy/plyer?branch=master

.. |travis| image:: https://travis-ci.org/kivy/plyer.svg?branch=master
:target: https://travis-ci.org/kivy/plyer

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/k1bwhdie0tfmdq96?svg=true
:target: https://ci.appveyor.com/project/KivyOrg/plyer

|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
Audio recording X X X
Barometer X X
Battery X X X X X
Bluetooth X X
Brightness X X X
Call X X
Camera (taking picture) X X
Compass X X
CPU count X X X
Email (open mail client) X X X X X
Flash X X
GPS X X
Gravity X X
Gyroscope X X
Humidity X
IR Blaster X
Light X
Native file chooser X X X
Notifications X X X X
Orientation X
Proximity X
Screenshot X X X
Sms (send messages) X X
Spatial Orientation X X
Speech to text X
Storage Path X 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
================================== ======= === ======= ==== =====

Support
-------

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

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:

* 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

License
-------

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