From 64b8e17892e6415e155dd014ef05239e56bde5be Mon Sep 17 00:00:00 2001 From: brian avery Date: Tue, 12 Jul 2016 10:04:34 -0700 Subject: [PATCH] toaster-manual: Switch to pip3 dependency installer Our switch to python3 requires us to dump the virtualenv approach as long as we need python to resolve to python2 in the same shell that python3 resolves to python3. To enable users to install Toaster's python package dependencies locally, we are changing to using pip3 and these doc changes explain how to do that. (From yocto-docs rev: 06b8820bcb90d1855ccb2712b616bb89847a148f) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../toaster-manual-setup-and-use.xml | 28 ++++---- .../toaster-manual/toaster-manual-start.xml | 71 ++++++------------- 2 files changed, 34 insertions(+), 65 deletions(-) diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml index ae59623e65..c70b91e016 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml @@ -116,12 +116,14 @@ create a superuser by following these steps: - If you used virtualenv, which is + If you used pip3, which is recommended, to set up the Toaster system dependencies, - you need be sure the virtual environment is activated. - To activate this environment, use the following command: + you need be sure the local user path is in your + PATH list. + To append the pip3 local user path, use the following + command: - $ source venv/bin/activate + $ export PATH=$PATH:$HOME/.local/bin @@ -213,14 +215,14 @@ If you are using Ubuntu 14.04.3, run the following: - $ sudo apt-get install apache2 libapache2-mod-wsgi mysql-server virtualenv libmysqlclient-dev + $ sudo apt-get install apache2 libapache2-mod-wsgi mysql-server python3-pip libmysqlclient-dev If you are using Fedora 22 or a RedHat distribution, run the following: - $ sudo dnf install httpd mod_wsgi python-virtualenv gcc mysql-devel + $ sudo dnf install httpd mod_wsgi gcc mysql-devel @@ -251,17 +253,15 @@ - Initialize a virtual environment and install Toaster - dependencies. - Using a virtual environment keeps the Python packages + Install Toaster + dependencies using the --user flag which + keeps the Python packages isolated from your system-provided packages: $ cd /var/www/toaster/ - $ virtualenv venv - $ source ./venv/bin/activate - $ pip install -r ./poky/bitbake/toaster-requirements.txt - $ pip install mysql - $ pip install MySQL-python + $ pip3 install --user -r ./poky/bitbake/toaster-requirements.txt + $ pip3 install --user mysql + $ pip3 install --user MySQL-python Isolating these packages is not required but is diff --git a/documentation/toaster-manual/toaster-manual-start.xml b/documentation/toaster-manual/toaster-manual-start.xml index daefa79090..c5c6795f65 100644 --- a/documentation/toaster-manual/toaster-manual-start.xml +++ b/documentation/toaster-manual/toaster-manual-start.xml @@ -22,6 +22,11 @@ and "Yocto Project Release" sections in the Yocto Project Quick Start. + For Ubuntu/Debian, you might also need to do an additional install + of pip3. + + $ sudo apt-get install python3-pip + @@ -42,56 +47,6 @@ install-compatible format. -
- Set Up a Python Virtual Environment - - - Set up a Python virtual environment that allows you - to maintain a dedicated Python executable and its own - set of installed modules. - Doing so separates the executable from Python and the - modules provided by the operating system. - This separation avoids any version conflicts. - - Creating a virtual environment is not absolutely - necessary. - However, doing so is highly recommended. - - - - - Follow these steps to set up your virtual environment. - These steps assume a Ubuntu distribution: - - Install virtualenv: - Install the supported - python-virtualenv package from your - distribution rather than using pip. - - $ sudo apt-get install python-virtualenv - - - Create and Activate a Virtual Environment: - - $ virtualenv venv - $ source venv/bin/activate - - - - - After setting up a virtual environment in - which to run Toaster, you must initialize that - virtual environment each time you want to start - Toaster. - Use the following to initialize the environment just - before you start Toaster: - - $ source venv/bin/activate - - - -
-
Install Toaster Packages @@ -99,7 +54,21 @@ You need to install the packages that Toaster requires. Use this command: - $ pip install -r bitbake/toaster-requirements.txt + $ $ pip3 install --user -r bitbake/toaster-requirements.txt + + The previous command installs the necessary Toaster modules + into a local python 3 cache in your + $HOME directory. + The caches is actually located in + $HOME/.local. + To see what packages have been installed into your + $HOME directory, do the following: + + $ pip3 list installed --local + + If you need to remove something, the following works: + + $ pip3 uninstall PackageNameToUninstall