diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..29d18fa --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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). + diff --git a/CONTACT.md b/CONTACT.md new file mode 100644 index 0000000..e96b3f5 --- /dev/null +++ b/CONTACT.md @@ -0,0 +1,6 @@ +# Contacting the Kivy Team + +If you are looking to contact the Kivy Team (who are responsible for managing +the Kivy SDK Packager project), including looking for support, please see our +latest [Contact Us](https://github.com/kivy/kivy/blob/master/CONTACT.md) +document. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b49587b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contribution Guidelines + +Kiby SDK Packaging 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/kivy/blob/master/CONTRIBUTING.md) +for how you can help us. diff --git a/LICENSE b/LICENSE index 9e49ad9..2422649 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,6 @@ -Copyright (c) 2015-2017 Kivy Team and other contributors +MIT License + +Copyright (c) 2015-2023 Kivy Team and other contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ff08d6b..462ee24 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,171 @@ -Kivy SDK Packager +kivy-sdk-packager ================= -This repository contains scripts for Kivy SDK generation on Windows, OS X and Linux. +`kivy-sdk-packager` is a collection of tools and scripts to build binaries +needed by [Kivy framework](https://kivy.org) 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](https://buildozer.readthedocs.io/) +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](https://kivy.org/about.html). + +[![Backers on Open Collective](https://opencollective.com/kivy/backers/badge.svg)](#backers) +[![Sponsors on Open Collective](https://opencollective.com/kivy/sponsors/badge.svg)](#sponsors) +[![GitHub contributors](https://img.shields.io/github/contributors-anon/kivy/kivy-sdk-packager)](https://github.com/kivy/kivy-sdk-packager/graphs/contributors) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) + +## Linux (Debian) + +Binaries for Linux are distributed as +[Personal Package Archives](https://launchpad.net/ubuntu/+ppas) (PPA) files. +They are built by Canonical and hosted on [Launchpad](https://launchpad.net/) to the +specifications (recipes) provided here. + +| Version | Binary | Source | +|--------------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| Stable Build | [Launchpad PPA packages](https://code.launchpad.net/~kivy-team/+archive/ubuntu/kivy/+packages) | [Launchpad recipes](https://code.launchpad.net/~kivy-team/+archive/ubuntu/kivy/+packages) | +| Daily Build | [Launchpad PPA packages](https://code.launchpad.net/~kivy-team/+archive/ubuntu/kivy-daily/+packages) | [Launchpad recipes](https://code.launchpad.net/~kivy-team/+archive/ubuntu/kivy-daily/+packages) | + +More information: [Linux README](linux/debian/README.md) + +## macOS + +Binaries for macOS are built as Disk Image (.DMG) or App (.APP) files. + +These can be built on the developer's machine. + + +[Buildozer](https://buildozer.readthedocs.io) encapsulates the use of +kivy-sdk-packager so the Kivy app developer does not need to be concerned with +it. + +[![macOS Tests](https://github.com/kivy/kivy-sdk-packager/actions/workflows/test_macos.yaml/badge.svg)](https://github.com/kivy/kivy-sdk-packager/actions/workflows/test_macos.yaml) + +More information: [macOS README](osx/README.md) + +## Windows + +Binaries for Windows are built as wheels that can be installed via +[pip](https://pypi.org/project/pip/). They are uploaded and hosted on the +[Python Package Index](https://pypi.org/) (PyPI). + +Four variants are released - they contain support for different +[OpenGL ES](https://en.wikipedia.org/wiki/OpenGL_ES) implementations and other +libraries: + +| Version | PyPI Name | +|-------------------------------------------------------------------------|----------------------------------------------------------------------| +| [Angle](https://chromium.googlesource.com/angle/angle/+/main/README.md) | [kivy-deps.angle](https://pypi.org/project/kivy-deps.angle/) | +| [Glew](https://glew.sourceforge.net/) | [kivy-deps.glew](https://pypi.org/project/kivy-deps.glew/) | +| [Gstreamer](https://gstreamer.freedesktop.org/) | [kivy-deps.gstreamer](https://pypi.org/project/kivy-deps.gstreamer/) | +| [SDL2](https://www.libsdl.org/) | [kivy-deps.sdl2](https://pypi.org/project/kivy-deps.sdl2/) | + +[![Windows Angle wheels](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_angle_wheels.yml/badge.svg)](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_angle_wheels.yml) +[![Windows Glew wheels](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_glew_wheels.yml/badge.svg)](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_glew_wheels.yml) +[![Windows Gstreamer wheels](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_gstreamer_wheels.yml/badge.svg)](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_gstreamer_wheels.yml) +[![Windows SDL2 wheels](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_sdl2_wheels.yml/badge.svg)](https://github.com/kivy/kivy-sdk-packager/actions/workflows/windows_sdl2_wheels.yml) + +More information: [Windows README](win/README.md) + +## License + +kivy-sdk-packager 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 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](https://github.com/kivy/kivy-sdk-packager/blob/master/CONTACT.md) +document. + +## Contributing + +kivy-sdk-packager 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/kivy-sdk-packager/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/kivy-sdk-packager/blob/master/CODE_OF_CONDUCT.md). + +## Contributors + +This project exists thanks to +[all the people who contribute](https://github.com/kivy/kivy-sdk-packager/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. + + + + + + + + + + + + + + + + + + + + + diff --git a/osx/README.md b/osx/README.md index c227090..0f057a9 100644 --- a/osx/README.md +++ b/osx/README.md @@ -11,10 +11,6 @@ The packaged dmg contains a Python virtualenv, Kivy and its binary dependencies provides an existing dmg containing the virtualenv and Kivy pre-installed that can be used as a base into which your app can be installed and packaged again as a dmg. Below are the steps: -**Note:** A Kivy.app build on one OS X version will typically -not work on older OS X versions. For older OS X versions, you need to build Kivy.app -on the oldest machine you wish to support. - * Get the Kivy sdk repo with e.g. ``git clone https://github.com/kivy/kivy-sdk-packager.git`` and ``cd`` into ``kivy-sdk-packager/osx``. diff --git a/win/common.py b/win/common.py index 3a5eba0..bd8ab53 100644 --- a/win/common.py +++ b/win/common.py @@ -181,7 +181,7 @@ def has_ext_modules(self): setup( name='{}', version='{}', - author='Kivy Crew', + author='Kivy Team and other contributors', author_email='kivy-dev@googlegroups.com', description='Repackaged binary dependency of Kivy.', url='http://kivy.org/',