2014-01-11 15:42:56 +00:00
Kivy
====
2015-04-30 18:00:05 +00:00
< img align = "right" height = "256" src = "https://raw.githubusercontent.com/kivy/kivy/master/kivy/data/logo/kivy-icon-256.png" / >
2014-01-11 15:42:56 +00:00
2023-11-23 17:31:19 +00:00
[Kivy ](https://www.kivy.org ) is an open-source [Python ](https://python.org ) framework
for developing GUI apps that work cross-platform, including desktop, mobile and
embedded platforms.
2014-01-11 15:42:56 +00:00
2015-05-21 15:47:06 +00:00
The aim is to allow for quick and easy interaction design and rapid prototyping
2023-11-23 17:31:19 +00:00
whilst making your code reusable and deployable: Innovative user interfaces made
easy.
2014-01-11 15:42:56 +00:00
2023-11-23 17:31:19 +00:00
Kivy is written in Python and [Cython ](https://cython.org/ ) and is built on
[OpenGL ES 2.0 ](https://www.khronos.org/opengles/ ). It supports various input
devices and has an extensive (and extensible) widget library. With the
same codebase, you can target Windows, macOS, Linux (including Raspberry Pi OS),
Android, and iOS. All Kivy widgets are built with multitouch support.
2014-01-11 15:42:56 +00:00
2023-11-23 17:31:19 +00:00
Kivy 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 ).
2014-01-11 15:42:56 +00:00
2019-11-29 23:58:39 +00:00
[](#backers)
[](#sponsors)
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
[](CODE_OF_CONDUCT.md)
[](https://github.com/kivy/kivy/graphs/contributors)
2023-11-23 17:31:19 +00:00
2019-11-29 23:58:39 +00:00
[](https://github.com/kivy/kivy/actions?query=workflow%3A%22Windows+Unittests%22)
[](https://github.com/kivy/kivy/actions?query=workflow%3A%22Ubuntu+Unittests%22)
[](https://github.com/kivy/kivy/actions?query=workflow%3A%22OSX+Unittests%22)
2023-11-23 17:31:19 +00:00
[](https://coveralls.io/r/kivy/kivy?branch=master)
2019-11-29 23:58:39 +00:00
[](https://github.com/kivy/kivy/actions?query=workflow%3A%22Windows+wheels%22)
[](https://github.com/kivy/kivy/actions?query=workflow%3A%22Manylinux+wheels%22)
2019-12-21 20:29:04 +00:00
[](https://github.com/kivy/kivy/actions?query=workflow%3A%22RPi+wheels%22)
2019-11-29 23:58:39 +00:00
[](https://github.com/kivy/kivy/actions?query=workflow%3A%22OSX+wheels%2Fapp%22)
2014-05-03 14:23:30 +00:00
2015-01-12 21:52:26 +00:00
Installation, Documentation and Examples
----------------------------------------
2014-01-11 15:42:56 +00:00
Extensive installation instructions as well as tutorials and general
2023-11-23 17:31:19 +00:00
documentation, including an API reference, can be found at https://www.kivy.org/docs.
2016-09-04 07:16:06 +00:00
A [PDF version ](https://media.readthedocs.org/pdf/kivy/latest/kivy.pdf ) is also available.
2014-01-11 15:42:56 +00:00
2015-05-21 15:47:06 +00:00
Kivy ships with many examples which can be found in the `examples` folder.
2014-01-11 15:42:56 +00:00
Support
-------
2023-11-23 17:31:19 +00:00
Are you having trouble using the Kivy framework, or any of its related projects?
Is there an error you don’
it? We have volunteers who can help!
2014-01-11 15:42:56 +00:00
2023-11-23 17:31:19 +00:00
The best channels to contact us for support are listed in the latest
[Contact Us ](CONTACT.md ) document.
2014-01-11 15:42:56 +00:00
2015-01-12 21:52:26 +00:00
Contributing
------------
2014-06-11 17:24:11 +00:00
We love pull requests and discussing novel ideas. Check out our
2023-11-23 17:31:19 +00:00
[latest contribution guide ](CONTRIBUTING.md ) and
2014-06-11 17:24:11 +00:00
feel free to improve Kivy.
2023-11-23 17:31:19 +00:00
It gives details of the best places online to discuss the development with the
core developers and other enthusiasts.
2014-06-11 17:24:11 +00:00
2023-11-23 17:31:19 +00:00
Sibling projects
----------------
2014-06-11 17:24:11 +00:00
2023-11-23 17:31:19 +00:00
The Kivy team manager a number of additional projects that support the Kivy
eco-system.
2014-01-11 15:42:56 +00:00
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
- [Buildozer ](https://github.com/kivy/buildozer ): a development tool for turning Python applications into binary packages ready for installation on
any of a number of platforms, including mobile devices.
- [Plyer ](https://github.com/kivy/plyer ): a platform-independent Python API for accessing hardware features of various platforms (Android, iOS,
macOS, Linux and Windows).
- [PyJNIus ](https://github.com/kivy/pyjnius ): a Python library for accessing Java classes using the Java Native Interface (JNI).
- [Pyobjus ](https://github.com/kivy/pyobjus ): Python module for accessing Objective-C classes as Python classes using
Objective-C runtime reflection.
- [Python for Android ](https://github.com/kivy/python-for-android ): a development tool that packages Python apps into binaries that can run on Android devices.
- [Kivy iOS ](https://github.com/kivy/kivy-ios ): a toolchain to compile the necessary libraries for iOS to run Kivy applications, and manage the
creation of Xcode projects.
2016-03-11 22:23:17 +00:00
- [Audiostream ](https://github.com/kivy/audiostream ): library for direct access
2015-12-09 19:21:32 +00:00
to the microphone and speaker.
2016-03-11 22:23:17 +00:00
- [KivEnt ](https://github.com/kivy/kivent ): entity-based game engine for Kivy.
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
- [Oscpy ](https://github.com/kivy/oscpy/ ): a Python implementation of Open Sound Control (OSC) network protocol.
2016-03-11 22:23:17 +00:00
- [Garden ](https://github.com/kivy-garden ): widgets and libraries created and
2015-12-09 19:21:32 +00:00
maintained by users.
2014-01-11 15:42:56 +00:00
Licenses
--------
2014-04-24 02:27:33 +00:00
- Kivy is released under the terms of the MIT License. Please refer to the
2023-11-23 17:31:19 +00:00
[LICENSE ](LICENSE ) file.
2015-08-01 23:59:41 +00:00
- The provided fonts Roboto and Roboto Mono are licensed and
2014-04-24 02:27:33 +00:00
distributed under the terms of the
2016-03-11 22:23:17 +00:00
[Apache License, Version 2.0 ](https://www.apache.org/licenses/LICENSE-2.0 ).
2015-05-21 15:06:20 +00:00
The DejaVuSans (used for the virtual keyboard) license can be viewed
2017-01-10 10:05:03 +00:00
[here ](https://github.com/dejavu-fonts/dejavu-fonts/blob/master/LICENSE ).
2014-04-24 02:27:33 +00:00
- The current UI design has been adapted from Moblintouch theme's SVGs
and is licensed under the terms of the
2016-03-11 22:23:17 +00:00
[LGPLv2.1 ](https://www.gnu.org/licenses/old-licenses/lgpl-2.1 ).
2018-12-03 16:05:22 +00:00
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
## 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/kivy/blob/master/CODE_OF_CONDUCT.md ).
2018-12-03 16:05:22 +00:00
## Contributors
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
This project exists thanks to
[all the people who contribute ](https://github.com/kivy/kivy/graphs/contributors ).
2023-11-23 17:31:19 +00:00
[[Become a contributor ](CONTRIBUTING.md )].
2018-12-03 16:05:22 +00:00
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
< img src = "https://contrib.nn.ci/api?repo=kivy/kivy&pages=5&no_bot=true&radius=22&cols=18" >
2018-12-03 16:05:22 +00:00
## Backers
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
Thank you to [all of our backers ](https://opencollective.com/kivy )!
🙏 [[Become a backer ](https://opencollective.com/kivy#backer )]
2018-12-03 16:05:22 +00:00
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
< img src = "https://opencollective.com/kivy/backers.svg?width=890&avatarHeight=44&button=false" >
2018-12-03 16:05:22 +00:00
## Sponsors
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
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 )].
2018-12-03 16:05:22 +00:00
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
Here are our top current sponsors. Please click through to see their websites,
and support them as they support us.
<!-- - See https://github.com/orgs/kivy/discussions/15 for explanation of this code. -->
2018-12-03 16:05:22 +00:00
< 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 >
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
2018-12-03 16:05:22 +00:00
< 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 >
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
2018-12-03 16:05:22 +00:00
< 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 >
2023-11-23 17:31:19 +00:00
< a href = "https://opencollective.com/kivy/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/kivy/sponsor/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/kivy/sponsor/11/website" target = "_blank" > < img src = "https://opencollective.com/kivy/sponsor/11/avatar.svg" > < / a >
Make doc structure consistent and up-to-date (#8514)
* 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.
CHECKLIST
* CONTRIBUTING.md
[X] If repo takes user contributions, is present
[X] In root dir (not .github dir)
[X] Explains relationship to Kivy, if unclear.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] Refers to kivy/kivy CONTACT.md
* FAQ.md
[X] If repo is big enough for RST documentation, is present.
* README:
[X] Is a Markdown file.
[X] Describes the project.
[X] Describes its place in the Kivy sibling projects.
[X] If Documentation exists, mention it.
[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.
[] Uses badges to display current status, including:
[X] Backers
[X] Sponsors
[X] GitHub contributors
[X] Contributor Covenant
[X] PyPI Version
[X] PyPI Python Version
[X] Build/Test status
[X] Displays all contributors to the repo.
[X] Displays backers
[X] Displays top sponsors.
* RST documentation, if present
[X] Describes the project.
[???] Describes its place in the Kivy sibling projects.
[X] Mentions (Kivy/Kivy) Contact Us link.
[X] Mentions LICENSE.
[X] Mentions CONTRIBUTING
[X] 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] NO_RESPONSE runs every day, and skips if forked.
[X] SUPPORT.yml is present if the repo has a `support` tag.
[X] SUPPORT.yml refers to repo's 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
* Review comment
2023-12-17 09:42:49 +00:00
2023-11-23 17:31:19 +00:00
< a href = "https://opencollective.com/kivy/sponsor/12/website" target = "_blank" > < img src = "https://opencollective.com/kivy/sponsor/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/kivy/sponsor/13/website" target = "_blank" > < img src = "https://opencollective.com/kivy/sponsor/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/kivy/sponsor/14/website" target = "_blank" > < img src = "https://opencollective.com/kivy/sponsor/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/kivy/sponsor/15/website" target = "_blank" > < img src = "https://opencollective.com/kivy/sponsor/15/avatar.svg" > < / a >
