Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update instalation.rst for Windows 10 #1123

Merged
merged 2 commits into from
Aug 17, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,47 @@ Android on Ubuntu 18.04 (64bit)
# add the following line at the end of your ~/.bashrc file
export PATH=$PATH:~/.local/bin/

Android on Windows 10
~~~~~~~~~~~~~~~~~~~~~

To use buildozer in Windows 10 you need first to enable Windows Subsystem for Linux (WSL) and install a Linux distribution: https://docs.microsoft.com/en-us/windows/wsl/install-win10.

These instructions were tested with WSL 1 and Ubuntu 18.04 LTS.

With WSL and Ubuntu installed on your Windows 10 machine, open Ubuntu and run these commands:

::

sudo apt update
sudo apt install -y git zip unzip openjdk-8-jdk python3-pip autoconf libtool pkg-config zlib1g-dev libncurses5-dev libncursesw5-dev libtinfo5 cmake libffi-dev libssl-dev
# Use here the python version you need
sudo apt install -y python3.7-venv
# Create a folder for buildozer
mkdir /mnt/c/buildozer
cd /mnt/c/buildozer
python3.7 -m venv venv-buildozer
source venv/bin/activate
python -m pip install --upgrade pip
python -m pip install --upgrade wheel
python -m pip install --upgrade cython
python -m pip install --upgrade virtualenv
python -m pip install --upgrade buildozer
# Add the following line at the end of your ~/.bashrc file
export PATH=$PATH:~/.local/bin/
# Restart your WSL terminal to enable the path change
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like most of this could reuse what already holds true in the Ubuntu install section above, that way we don't repeat ourselves

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I 'm gonna change it


Now you need to install the Windows version of ADB (Android Debug Bridge):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't the version "shipped" by buildozer enough?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my tests ADB for Windows was needed to detect the USB connected Android device. Maybe Windows Subsystem for Linux does not have direct access to hardware. ADB in Windows detects the USB device and start the daemon. ADB in buildozer (in WSL) connects to the daemon and access the USB device.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, i did spend some time supporting an user in that case sometime ago, WSL indeed doesn't have USB support, so the only way is to use the adb daemon started in windows.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's probably a good idea to add a note so they get the same adb version as the one installed by buildozer, even if it's probably going to happen by default most of the time, as if they do not, every time they will run one adb on any side, this one will kill the daemon and restart it, so it won't work.


- Go to https://developer.android.com/studio/releases/platform-tools and click on "Download SDK Platform-Tools for Windows".

- Unzip the downloaded file to a new folder. For example, "C:\\platform-tools".

Before Using Buildozer
----------------------

If you wish, clone your code to a new folder, where the build process will run. You don't need to create a virtualenv for your code requirements. But just add these requirements to a configuration file called buildozer.spec as you will see in the following sections.

Before running buildozer in your code folder, remember to go into the buildozer folder and activate the buildozer virtualenv.

TroubleShooting
~~~~~~~~~~~~~~~
Expand Down