=========== Cookiedozer

Please note that this project is no longer actively maintained. 🚧

Feature-rich Cookiecutter_ template for Python Kivy_ apps that greatly simplifies the deployment to Android devices using Buildozer_.

For a minimal Kivy_ app template please check out cookiecutter-kivy_.

Features

• Installable PyPI_ package featuring a setup.py and a TestCommand
• Test suite running pytest_ that includes a fixture for your app using the InteractiveLauncher
• Sphinx_ docs that can be used to generate a readable html documentation
• Buildozer_ spec file that is used to deploy your app to an Android mobile device
• Makefile featuring several targets for important tasks such as coverage and apk
• Comprehensive README.rst file that contains useful information about your app

Usage

Generate a Kivy project::

cookiecutter https://github.com/hackebrot/cookiedozer

Tutorials

Parts of this template are explained in great detail over the course of the following tutorials:

• Part 1: Create your own Cookiecutter template_
• Part 2: Extending our Cookiecutter template_
• Part 3: Wrapping up our Cookiecutter template_

Constraints

The tool at hand for creating and deploying an apk, namely Buildozer_, is currently in beta stage. Although it doesn’t depend on any library, you must have a Linux or OSX computer to be able to compile for Android.

See Buildozer Docs_.

License

Distributed under the terms of the MIT license_, Cookiedozer is free and open source software

Issues

This template has been tested on Ubuntu Trusty Tahr as well as Mac OS X Yosemite.

If you encounter any problems, please file an issue_ along with a detailed description.

Examples

.. image:: https://raw.githubusercontent.com/hackebrot/cookiedozer/master/cookiedozer01.png .. image:: https://raw.githubusercontent.com/hackebrot/cookiedozer/master/cookiedozer02.png

.. _Buildozer Docs: http://buildozer.readthedocs.org/en/latest/index.html .. _Buildozer: https://github.com/kivy/buildozer .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _Create your own Cookiecutter template: https://raphael.codes/blog/create-your-own-cookiecutter-template/ .. _Extending our Cookiecutter template: https://raphael.codes/blog/extending-our-cookiecutter-template/ .. _Kivy: https://github.com/kivy/kivy .. _MIT License: http://opensource.org/licenses/MIT .. _PyPI: https://pypi.python.org/pypi .. _Sphinx: http://sphinx-doc.org/ .. _Wrapping up our Cookiecutter template: https://raphael.codes/blog/wrapping-up-our-cookiecutter-template/ .. _cookiecutter-kivy: https://github.com/hackebrot/cookiecutter-kivy .. _file an issue: https://github.com/hackebrot/cookiedozer/issues .. _pytest: http://pytest.org/latest/