Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kivy/plyer
Plyer is a platform-independent Python wrapper for platform-dependent APIs
https://github.com/kivy/plyer
android api-wrapper ios linux macos python windows
Last synced: about 2 months ago
JSON representation
Plyer is a platform-independent Python wrapper for platform-dependent APIs
- Host: GitHub
- URL: https://github.com/kivy/plyer
- Owner: kivy
- License: mit
- Created: 2013-01-23T00:27:33.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T13:58:41.000Z (6 months ago)
- Last Synced: 2024-04-14T11:01:22.800Z (5 months ago)
- Topics: android, api-wrapper, ios, linux, macos, python, windows
- Language: Python
- Homepage: https://plyer.readthedocs.io
- Size: 1.36 MB
- Stars: 1,532
- Watchers: 91
- Forks: 415
- Open Issues: 169
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Plyer
Plyer is a platform-independent Python API for accessing hardware features
of various platforms (Android, iOS, macOS, Linux and Windows).
Plyer is managed by the [Kivy Team](https://kivy.org/about.html). It is suitable for
use with Kivy apps, but can be used independently.
[](#backers)
[](#sponsors)
[](https://github.com/kivy/plyer/graphs/contributors)
[](code_of_conduct.md)
[](https://coveralls.io/r/kivy/plyer?branch=master)
## How plyer works?
Plyer tries not to reinvent the wheel, and will call external libraries to
implement the API in the easiest way, depending on the current platform.
- On Android ([python-for-android](https://python-for-android.readthedocs.io/)), [PyJNIus](https://pypi.org/project/pyjnius/) is used.
- On iOS ([kivy-ios](https://pypi.org/project/kivy-ios/)) and macOS,
[pyobjus](https://pypi.org/project/pyobjus/) is used.
- On Windows, macOS and Linux, other commonly found libraries and programs
are used.
## Supported APIs
| Platform | Android | iOS | Windows | macOS | Linux |
| ------------------------------ |:-------:|:---:|:-------:|:-----:|:-----:|
| Accelerometer | ✔ | ✔ | | ✔ | ✔ |
| Audio recording | ✔ | | ✔ | ✔ | |
| Barometer | ✔ | ✔ | | | |
| Battery | ✔ | ✔ | ✔ | ✔ | ✔ |
| Bluetooth | ✔ | | | ✔ | |
| Brightness | ✔ | ✔ | | | ✔ |
| Call | ✔ | ✔ | | | |
| Camera (taking picture) | ✔ | ✔ | | | |
| Compass | ✔ | ✔ | | | |
| CPU count | | | ✔ | ✔ | ✔ |
| Devicename | ✔ | | ✔ | ✔ | ✔ |
| Email (open mail client) | ✔ | ✔ | ✔ | ✔ | ✔ |
| Flash | ✔ | ✔ | | | |
| GPS | ✔ | ✔ | | | |
| Gravity | ✔ | ✔ | | | |
| Gyroscope | ✔ | ✔ | | | |
| Humidity | ✔ | | | | |
| IR Blaster | ✔ | | | | |
| Keystore | ✔ | ✔ | ✔ | ✔ | ✔ |
| Light | ✔ | | | | |
| Maps | | ✔ | | ✔ | |
| Native file chooser | ✔ | ✔ | ✔ | ✔ | ✔ |
| Notifications | ✔ | | ✔ | ✔ | ✔ |
| Orientation | ✔ | | | | ✔ |
| Proximity | ✔ | | | | |
| Screenshot | | | ✔ | ✔ | ✔ |
| SMS (send messages) | ✔ | ✔ | | ✔ | |
| Spatial Orientation | ✔ | ✔ | | | |
| Speech to text | ✔ | | | | |
| Storage Path | ✔ | ✔ | ✔ | ✔ | ✔ |
| Temperature | ✔ | | | | |
| Text to speech | ✔ | ✔ | ✔ | ✔ | ✔ |
| Unique ID | ✔ | ✔ | ✔ | ✔ | ✔ |
| Vibrator | ✔ | ✔ | | | |
| Wifi | | | ✔ | ✔ | ✔ |
## Documentation
Full documentation, including details about the API, is available
[online](https://plyer.readthedocs.io/en/latest/). If you are not using the
latest version of Plyer, earlier versions of the documentations are linked
from there.
## Installation
To use on desktop: `pip install plyer`
To use in python-for-android and Kivy for iOS, add `plyer` to your requirements
if needed.
## License
Plyer is [MIT licensed](LICENSE), actively developed by a great
community and is supported by many projects managed by the
[Kivy Organization](https://www.kivy.org/about.html).
## Support
Are you having trouble using Plyer or any of its related projects in the Kivy
ecosystem?
Is there an error you don’t understand? Are you trying to figure out how to use
it? We have volunteers who can help!
The best channels to contact us for support are listed in the latest
[Contact Us](https://github.com/kivy/plyer/blob/master/CONTACT.md) document.
## Contributing
Plyer is part of the [Kivy](https://kivy.org) ecosystem - a large group of
products used by many thousands of developers for free, but it
is built entirely by the contributions of volunteers. We welcome (and rely on)
users who want to give back to the community by contributing to the project.
Contributions can come in many forms. See the latest
[Contribution Guidelines](https://github.com/kivy/plyer/blob/master/CONTRIBUTING.md)
for how you can help us.
## Code of Conduct
In the interest of fostering an open and welcoming community, we as
contributors and maintainers need to ensure participation in our project and
our sister projects is a harassment-free and positive experience for everyone.
It is vital that all interaction is conducted in a manner conveying respect,
open-mindedness and gratitude.
Please consult the [latest Code of Conduct](https://github.com/kivy/plyer/blob/master/CODE_OF_CONDUCT.md).
## Contributors
This project exists thanks to
[all the people who contribute](https://github.com/kivy/plyer/graphs/contributors).
[[Become a contributor](CONTRIBUTING.md)].
## Backers
Thank you to [all of our backers](https://opencollective.com/kivy)!
🙏 [[Become a backer](https://opencollective.com/kivy#backer)]
## Sponsors
Special thanks to
[all of our sponsors, past and present](https://opencollective.com/kivy).
Support this project by
[[becoming a sponsor](https://opencollective.com/kivy#sponsor)].
Here are our top current sponsors. Please click through to see their websites,
and support them as they support us.
