eliasdorneles / beeware-android-template

Template for starting a native Android app using Python and the BeeWare tools
MIT License
36 stars 5 forks source link
android beeware cookiecutter-template python python-on-android voc

BeeWare Android Template

A template for starting a native Android app using Python and the BeeWare tools.

More specifically, it uses VOC for compiling Python into Java bytecode and Briefcase to package as an Android app.

Using this template

Requirements: you need to have Python 3, Java JDK and the Android SDK_ installed

  1. Create a virtualenv using Python 3 (3.5 recommended).

  2. Install cookiecutter_. This is a tool used to bootstrap complex project templates::

    $ pip install cookiecutter

  3. Run cookiecutter on this template::

    $ cookiecutter https://github.com/eliasdorneles/beeware-android-template

  4. Add your code to the project.

  5. Install Briefcase_. This is a tool that produces a version of your project that can be deployed to specific platforms::

    $ pip install briefcase

  6. Start the Android emulator or connect your Android device_

  7. Build and run your app with::

    $ python setup.py android --start

Example apps

.. _cookiecutter: https://github.com/audreyr/cookiecutter .. _briefcase: https://github.com/pybee/briefcase .. _VOC: https://github.com/pybee/voc .. _TicTacToe: https://github.com/eliasdorneles/tictactoe-voc .. _Drawing app: https://github.com/eliasdorneles/drawingapp-voc .. _Todo app: https://github.com/eliasdorneles/todoapp-voc .. _Android SDK: https://developer.android.com/studio/index.html#downloads .. _APK: https://en.wikipedia.org/wiki/Android_application_package .. _connect your Android device: https://code.tutsplus.com/articles/connecting-physical-android-devices-to-your-development-machine--mobile-12376