summaryrefslogtreecommitdiff
path: root/external/plyer/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'external/plyer/README.rst')
-rw-r--r--external/plyer/README.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/external/plyer/README.rst b/external/plyer/README.rst
new file mode 100644
index 0000000..56860db
--- /dev/null
+++ b/external/plyer/README.rst
@@ -0,0 +1,38 @@
+Plyer
+=====
+
+Plyer is a platform-independent api to use features commonly found on various
+platforms, notably mobile ones, in Python.
+
+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
+
+Support
+-------
+
+================================== ============= ============= === ======= === =====
+Platform Android < 4.0 Android > 4.0 iOS Windows OSX Linux
+================================== ============= ============= === ======= === =====
+Accelerometer X X X X X
+Camera (taking picture) X X
+GPS X X X
+Notifications X X X X X
+Text to speech X X X X X X
+Email (open mail client) X X X X X X
+Vibrator X X
+Sms (send messages) X X
+Compass X X X
+Unique ID (IMEI or SN) X X X X X X
+Gyroscope X X X
+Battery X X X X X X
+Native file chooser X X X
+Orientation X X
+Audio recording X X
+================================== ============= ============= === ======= === =====