Skip to content

Commit c5452bd

Browse files
committed
Added initial plyer doc
1 parent d954c90 commit c5452bd

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

doc/source/apis.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,17 @@ along with explanation of how to include these modules in your APKs.
2727
Using Pyjnius
2828
-------------
2929

30-
Pyjnius lets you call the Android API directly from Python. You can
31-
include it in your APKs by adding the `pyjnius` or `pyjniussdl2`
32-
recipes to your build requirements (the former works with Pygame/SDL1,
33-
the latter with SDL2, the need to make this choice will be removed
34-
later when pyjnius internally supports multiple Android backends). It
35-
is automatically included in any APK containing Kivy, in which case
36-
you don't need to specify it manually.
30+
Pyjnius lets you call the Android API directly from Python; this let's
31+
you do everything you can (and probably would) do in a Java app, from
32+
vibration, to starting other applications, to getting sensor data, to
33+
controlling settings like screen orientation and wakelocks.
34+
35+
You can include Pyjnius in your APKs by adding the `pyjnius` or
36+
`pyjniussdl2` recipes to your build requirements (the former works
37+
with Pygame/SDL1, the latter with SDL2, the need to make this choice
38+
will be removed later when pyjnius internally supports multiple
39+
Android backends). It is automatically included in any APK containing
40+
Kivy, in which case you don't need to specify it manually.
3741

3842
The basic mechanism of Pyjnius is the `autoclass` command, which wraps
3943
a Java class. For instance, here is the code to vibrate your device::
@@ -82,4 +86,12 @@ You can check the `Pyjnius documentation <Pyjnius_>`_ for further details.
8286
Using Plyer
8387
-----------
8488

89+
Plyer aims to provide a much less verbose, Pythonic wrapper to
90+
platform-specific APIs. Android is a supported platform, but it also
91+
supports iOS and desktop operating systems, with the idea that the
92+
same Plyer code would do the right thing on any of them, though Plyer
93+
is a work in progress and not all platforms support all Plyer calls
94+
yet.
8595

96+
You can include Plyer in your APKs by adding the `Plyer` recipe to
97+
your build requirements. It is not included automatically.

0 commit comments

Comments
 (0)