mirror of https://github.com/kivy/kivy.git
140 lines
4.2 KiB
ReStructuredText
140 lines
4.2 KiB
ReStructuredText
.. _packaging_ios:
|
|
|
|
Create a package for IOS
|
|
========================
|
|
|
|
.. versionadded:: 1.2.0
|
|
|
|
.. warning::
|
|
|
|
This method is still under development.
|
|
|
|
The overall method for creating a package on IOS can be explained in 4 steps:
|
|
|
|
#. Compile python + modules for IOS
|
|
#. Create an Xcode project
|
|
#. Populate the Xcode project with your application source code
|
|
#. Customize
|
|
|
|
The current method have been tested with Xcode 4.2
|
|
|
|
Prerequisites
|
|
-------------
|
|
|
|
You need to install some dependencies, like cython or mercurial. If you're
|
|
using Xcode 4.3, then you also need to install autotools. We encourage you to
|
|
use `Homebrew <http://mxcl.github.com/homebrew/>`_ to install thoses dependencies::
|
|
|
|
brew install cython autoconf automake libtool pkg-config mercurial
|
|
brew link libtool
|
|
brew link mercurial
|
|
|
|
Ensure that everything is ok before starting the second step!
|
|
|
|
.. _Compile the distribution:
|
|
|
|
Compile the distribution
|
|
------------------------
|
|
|
|
Open a terminal, and::
|
|
|
|
$ git clone git://github.com/kivy/kivy-ios
|
|
$ cd kivy-ios
|
|
$ tools/build-all.sh
|
|
|
|
If you don't want to compile all the things needed for kivy, edit and change
|
|
`tools/build-all.sh` to your needs.
|
|
|
|
Most of the python distribution will be packed into a `python27.zip`.
|
|
|
|
.. _Create an Xcode project:
|
|
|
|
Create an Xcode project
|
|
-----------------------
|
|
|
|
Before doing the next step, ensure your application entry point is a file named
|
|
`main.py`.
|
|
|
|
We provide a script that create an initial xcode project to start with (replace
|
|
test with that you want. Must be a name without any space / weird chars)::
|
|
|
|
$ tools/create-xcode-project.sh test /path/to/your/appdir
|
|
|
|
Now you can open the Xcode project::
|
|
|
|
$ open app-test/test.xcodeproj
|
|
|
|
.. _Customize:
|
|
|
|
Customize
|
|
---------
|
|
|
|
You can customize the build in many ways:
|
|
|
|
#. Minimize the `build/python/lib/python27.zip`: this contain all the python
|
|
modules. You can edit the zip file, and remove all the files you'll not use
|
|
(reduce encodings, remove xml, email...)
|
|
#. Remove the .a not used: in Xcode, select your target, go in `Build Phases`,
|
|
then check the `Link Binary With Libraries`. You can remove the libraries
|
|
not used by your application.
|
|
#. Change the icon, orientation, etc... According to the Apple policy :)
|
|
#. Go to the settings panel > build, search for "strip" options, and
|
|
triple-check that they are all set to NO. Stripping is not working with
|
|
Python dynamic modules, and will strip needed symbols.
|
|
|
|
.. _Known issues:
|
|
|
|
Known issues
|
|
------------
|
|
|
|
Currently, the project have few issues as (we'll fixes them during the
|
|
development):
|
|
|
|
- Loading time: Apple provide a way to reduce the feeling of a slow application
|
|
loading by showing an image when the application is initialize. But, due to
|
|
the SDL approach, IOS remove the launch image before we have started. So if
|
|
you are using a launch image, the user will see: The launch image -> black
|
|
screen -> your app. Remove the launch image for now.
|
|
|
|
- Application configuration not writing: we are learning how IOS manage its
|
|
filesystem.
|
|
|
|
- You can't export your project outside kivy-ios directory, because the
|
|
libraries included in the project are relative to it.
|
|
|
|
- Removing some libraries (like SDL_Mixer for the sound) is currently not
|
|
possible cause kivy project need it.
|
|
|
|
- And more, just too technical to be written here.
|
|
|
|
.. _ios_packaging_faq:
|
|
|
|
FAQ
|
|
---
|
|
|
|
Application quit abnormally!
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
By default, all the print on the console and files are avoided. If you have an
|
|
issue when running your application, you can activate the log by commenting the
|
|
line in the main.m::
|
|
|
|
putenv("KIVY_NO_CONSOLELOG=1");
|
|
|
|
Then, you should see all the Kivy log on the Xcode console.
|
|
|
|
How Apple can accept a python app ?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
We managed to merge the app binary with all the libraries into only one binary,
|
|
as libpython. At the end, all binaries modules are already loaded, nothing is
|
|
dynamically loaded.
|
|
|
|
Did you already submit a Kivy application to the App store ?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Yes, check:
|
|
|
|
- `Defletouch on iTunes <http://itunes.apple.com/us/app/deflectouch/id505729681>`_,
|
|
- `ProcessCraft on iTunes <http://itunes.apple.com/us/app/processcraft/id526377075>`_
|