Skip to content

Scripts for Kivy SDK generation on Windows, OS X and Linux

License

Notifications You must be signed in to change notification settings

kivy/kivy-sdk-packager

Repository files navigation

kivy-sdk-packager

kivy-sdk-packager is a collection of tools and scripts to build binaries needed by Kivy framework apps for different platforms.

Note

The name has become a misnomer as the project has evolved; it is no longer about Software Development Kits.

The tools are intended to be run in automated build environments, including Continuos Integration (CI) and Continuous Delivery (CD) tools.

Each platform targeted by the Kivy framework has its own needs. Hence, the scripts for each platform are quite different in scope. This repository contains scripts Windows, macOS and Linux.

For most platforms, this repository contains behind-the-scenes scripts. There is no need for developers of Kivy apps to be aware of them.

macOS developers may want to use the scripts here for packaging, but it is recommended that they use Buildozer instead. It encapsulates the use of kivy-sdk-packager.

You can find a detailed README.md document inside every platform folder. They explain what the provided files do, what artefacts are produced, and what steps are required for each new release.

kivy-sdk-packager is managed by the Kivy Team.

Backers on Open Collective Sponsors on Open Collective GitHub contributors Contributor Covenant

Linux (Debian)

Binaries for Linux are distributed as Personal Package Archives (PPA) files. They are built by Canonical and hosted on Launchpad to the specifications (recipes) provided here.

Version Binary Source
Stable Build Launchpad PPA packages Launchpad recipes
Daily Build Launchpad PPA packages Launchpad recipes

More information: Linux README

macOS

Binaries for macOS are built as Disk Image (.DMG) or App (.APP) files.

These can be built on the developer's machine.

Buildozer encapsulates the use of kivy-sdk-packager so the Kivy app developer does not need to be concerned with it.

macOS Tests

More information: macOS README

Windows

Binaries for Windows are built as wheels that can be installed via pip. They are uploaded and hosted on the Python Package Index (PyPI).

Four variants are released - they contain support for different
OpenGL ES implementations and other libraries:

Version PyPI Name
Angle kivy-deps.angle
Glew kivy-deps.glew
Gstreamer kivy-deps.gstreamer
SDL2 kivy-deps.sdl2

Windows Angle wheels Windows Glew wheels Windows Gstreamer wheels Windows SDL2 wheels

More information: Windows README

License

kivy-sdk-packager is MIT licensed, actively developed by a great community and is supported by many projects managed by the Kivy Organization.

Support

Are you having trouble using kivy-sdk-packager 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 document.

Contributing

kivy-sdk-packager is part of the Kivy 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 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.

Contributors

This project exists thanks to all the people who contribute. [Become a contributor].

Backers

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

Sponsors

Special thanks to all of our sponsors, past and present. Support this project by [becoming a sponsor].

Here are our top current sponsors. Please click through to see their websites, and support them as they support us.