Skip to content

/ plyer

Plyer is a platform-independent Python wrapper for platform-dependent APIs
python api-wrapper windows linux macos ios android
Python HTML Shell Other
  1. Python 93.9%
  2. HTML 4.1%
  3. Shell 1.4%
  4. Other 0.6%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@AndreMiras
AndreMiras Uses Python 3 syntax (#554) 
This is a follow up for:
#553
- updates `super()` syntax
- removes `object` inheritance
- removes `from __future__ import unicode_literals`
Latest commit 11b6b4b Apr 10, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Switch to GitHub actions (#544) Mar 26, 2020
ci
docs Fix lots of PEP8 errors and warnings Jul 2, 2018
examples Uses Python 3 syntax (#554) Apr 10, 2020
plyer Uses Python 3 syntax (#554) Apr 10, 2020
.gitattributes Fix CRLF/LF for entrypoint.sh with gitattributes Jul 31, 2018
.gitignore Added .coverage to .gitignore Dec 24, 2018
CHANGELOG.md update CHANGELOG.md Mar 23, 2017
LICENSE Update copyright year Aug 11, 2017
MANIFEST.in add initial changelog Jan 27, 2015
Makefile updated kivy pep8 and corrected some files May 13, 2015
README.md Switch to GitHub actions (#544) Mar 26, 2020
devrequirements.txt Switch to GitHub actions (#544) Mar 26, 2020
setup.py Remove unused linters (#548) Apr 10, 2020

README.md

Plyer

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

coverage Backers on Open Collective Sponsors on Open Collective Continuous Integration with Ubuntu Continuous Integration with OSX Continuous Integration with Windows Deploy to PyPI

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 ✔ ✔ ✔ ✔
Audio recording ✔ ✔ ✔
Barometer ✔ ✔
Battery ✔ ✔ ✔ ✔ ✔
Bluetooth ✔ ✔
Brightness ✔ ✔ ✔
Call ✔ ✔
Camera (taking picture) ✔ ✔
Compass ✔ ✔
CPU count ✔ ✔ ✔
Email (open mail client) ✔ ✔ ✔ ✔ ✔
Flash ✔ ✔
GPS ✔ ✔
Gravity ✔ ✔
Gyroscope ✔ ✔
Humidity ✔
IR Blaster ✔
Light ✔
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 ✔ ✔ ✔

Support

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

Discord channel:

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.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

You can’t perform that action at this time.