-
Notifications
You must be signed in to change notification settings - Fork 425
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make doc structure consistent and up-to-date
This is part of an effort to make the Kivy sibling projects' documentation structure consistent and up-to-date. Unrelated changes: * Readme Copy-edit. Reformat markdown table * RST added structure, including API page * Congrats, promoted from "beta" to "stable" in setup classifiers CHECKLIST * CONTRIBUTING.md [x] If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Refers to kivy/kivy Contribution Guidelines. * LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License. * CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT.md * CONTACT.md [x] Refers to kivy/kivy CONTACT.md * FAQ.md [NA] If repo is big enough for RST documentation, is present. (RST documentation exists but is trivial) * README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status. * RST documentation, if present [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] Mentions LICENSE. [x] Mentions CONTRIBUTING [NA] Mentions FAQ [x] conf.py mentioned Kivy Team and other contributors - copyright, latex_documents, man_pages, texinfo documents * WORKFLOWS [x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [x] NO_RESPONSE uses latest script versions. [x] SUPPORT.yml is present if the repo has a `support` tag. [x] SUPPORT.yml refers to kivy/kivy CONTACT.md * setup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [x] Supplies Documentation, if any, to PyPI
- Loading branch information
Showing
12 changed files
with
194 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: 'Support Requests' | ||
|
|
||
| on: | ||
| issues: | ||
| types: [labeled, unlabeled, reopened] | ||
|
|
||
| permissions: | ||
| issues: write | ||
|
|
||
| jobs: | ||
| action: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: dessant/support-requests@v4 | ||
| with: | ||
| github-token: ${{ github.token }} | ||
| support-label: 'support' | ||
| issue-comment: > | ||
| 👋 We use the issue tracker exclusively for bug reports and feature requests. | ||
| However, this issue appears to be a support request. Please use our | ||
| [support channels](https://github.com/kivy/kivy/blob/master/CONTACT.md) | ||
| to get help with the project. | ||
| Let us know if this comment was made in error, and we'll be happy | ||
| to reopen the issue. | ||
| close-issue: true | ||
| lock-issue: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| 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 Kivy Code of Conduct](https://github.com/kivy/kivy/blob/master/CODE_OF_CONDUCT.md). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Contacting the Kivy Team | ||
|
|
||
| Are you having trouble using the Kivy framework, or any of its related projects? | ||
| 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/kivy/blob/master/CONTACT.md) document. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Contribution Guidelines | ||
|
|
||
| Kivy is a large product 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 | ||
| [Kivy Contribution Guidelines](https://github.com/kivy/kivy/blob/master/CONTRIBUTING.md) | ||
| for how you can help us. | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,134 +1,113 @@ | ||
| # Plyer | ||
|
|
||
| Plyer is a platform-independent api to use features commonly found on various | ||
| platforms, notably mobile ones, in Python. | ||
| Plyer is a platform-independent Python API for accessing features | ||
| of various hardware platforms, especially Android and iOS devices. | ||
|
|
||
| Plyer is managed by the [Kivy Team](https://kivy.org/about.html) and is suitable for | ||
| use with Kivy apps. | ||
|
|
||
| [](https://opencollective.com/kivy) | ||
| [](https://opencollective.com/kivy) | ||
| [](code_of_conduct.md) | ||
|
|
||
|  | ||
|  | ||
|
|
||
|
|
||
| [](https://coveralls.io/r/kivy/plyer?branch=master) | ||
| [](#backers) | ||
| [](#sponsors) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|
|
||
| ## How plyer works? | ||
|
|
||
| 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. | ||
| 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), pyjnius is used | ||
| - On iOS(kivy-ios), pyobjus is used | ||
| - On windows/mac/linux, commonly found libraries and programs will be used | ||
| - 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/)), [pyobjus](https://pypi.org/project/pyobjus/) is used. | ||
| - On Windows, macOS and 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 | | | ✔ | ✔ | ✔ | | ||
| | 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 | | | ✔ | ✔ | ✔ | | ||
| | 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 | | | ✔ | ✔ | ✔ | | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| To use on desktop: `pip install plyer` | ||
| To use in python-for-android/kivy-ios: add `plyer` to your requirements if needed. | ||
|
|
||
| ## Support | ||
|
|
||
| If you need assistance, you can ask for help on our mailing list: | ||
|
|
||
| * User Group : https://groups.google.com/group/kivy-users | ||
| * Email : [email protected] | ||
|
|
||
| Discord channel: | ||
|
|
||
| * Server : https://chat.kivy.org | ||
| * Channel : #dev | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| We love pull requests and discussing novel ideas. Check out our | ||
| [contribution guide](http://kivy.org/docs/contribute.html) 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 : [email protected] | ||
|
|
||
| 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. | ||
|
|
||
| ## Contributors | ||
| Kivy for iOS 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). | ||
|
|
||
| This project exists thanks to all the people who contribute. [[Contribute](http://kivy.org/docs/contribute.html)]. | ||
| ## Support | ||
|
|
||
| <a href="https://github.com/kivy/plyer/graphs/contributors"><img src="https://contrib.rocks/image?repo=kivy/plyer"/></a> | ||
| Are you having trouble using the Kivy framework, or any of its related projects? | ||
| Is there an error you don’t understand? Are you trying to figure out how to use | ||
| it? We have volunteers who can help! | ||
|
|
||
| ## Backers | ||
| The best channels to contact us for support are listed in the latest | ||
| [Contact Us](https://github.com/kivy/kivy/blob/master/CONTACT.md) document. | ||
|
|
||
| Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/kivy#backer)] | ||
| ## Contributing | ||
|
|
||
| <a href="https://opencollective.com/kivy#backers" target="_blank"><img src="https://opencollective.com/kivy/backers.svg?width=890"></a> | ||
| Kivy is a large product 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 | ||
| [Kivy Contribution Guidelines](https://github.com/kivy/kivy/blob/master/CONTRIBUTING.md) | ||
| for how you can help us. | ||
|
|
||
| ## Sponsors | ||
| ## Code of Conduct | ||
|
|
||
| Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/kivy#sponsor)] | ||
| 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. | ||
|
|
||
| <a href="https://opencollective.com/kivy/sponsor/0/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/0/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/1/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/1/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/2/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/2/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/3/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/3/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/4/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/4/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/5/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/5/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/6/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/6/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/7/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/7/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/8/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/8/avatar.svg"></a> | ||
| <a href="https://opencollective.com/kivy/sponsor/9/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/9/avatar.svg"></a> | ||
| Please consult the [latest Kivy Code of Conduct](https://github.com/kivy/kivy/blob/master/CODE_OF_CONDUCT.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
|
|
||
| .. _api: | ||
|
|
||
| API | ||
| === | ||
|
|
||
| .. automodule:: plyer | ||
| :members: | ||
|
|
||
| .. automodule:: plyer.facades | ||
| :members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| .. _contact: | ||
|
|
||
| Contact Us | ||
| ========== | ||
|
|
||
| If you are looking to contact us, including looking for support, please see our | ||
| `latest contact details <https://github.com/kivy/kivy/blob/master/CONTACT.md>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| .. _contribute: | ||
|
|
||
| Contribution Guidelines | ||
| ======================= | ||
|
|
||
| Kivy is a large product 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. To learn more, see our | ||
| `latest Contribution Guidelines <https://github.com/kivy/kivy/blob/master/CONTRIBUTING.md>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.