-
Notifications
You must be signed in to change notification settings - Fork 858
Installation
The installation of the objection
python component should be relatively simple. In fact, a simple pip3 install objection
will suffice.
Before continuing with the installation though, make sure you have the following prerequisites met:
-
python
version 3.4+. Check your version with:python -V
, upgrade/install using your distributions package manager. -
pip3
version 9.0+. Check your version with:pip --version
, upgrade with:pip install pip --upgrade
. - (optionally)
virtualenv
version 15+. Check your version with:virtualenv --version
, upgrade/install with:pip install virtualenv --upgrade
.
- Android build tools, specifically: adb, aapt, apksigner, zipalign
-
apktool>=2.9.0
Available from https://apktool.org/docs/install.
- XCode
-
applesign
(npm install -g applesign
) -
insert_dylib
https://github.com/Tyilo/insert_dylib
By 'native', we are referring to a non-virtualenv
installation, where all of the objection
dependencies will be installed in your operating systems python module path. There is nothing wrong with this really, but some may prefer to have isolated environments for certain programs. If this is you, check out the next section.
-
Make sure your system meets the prerequisites detailed in the previous section.
-
Next, start the installation using
pip3
with:
pip3 install -U objection
- Once the dependencies are installed, the
objection
command should be available in yourPATH
. In some shells, it may be necessary to runhash -r
before the command will be available.
By 'virtual', we are referring to the fact that objection
will be installed in an isolated Python virtual environment. For many, this is the preferred option as objection
dependencies will not affect any locally installed dependencies within the operating systems module path.
-
Make sure your system meets the prerequisites detailed in the previous section, including the
virtualenv
command. -
Create a new virtual environment with:
python3 -m venv ~/objection-venv
- Activate your new Python virtual environment with:
source ~/objection-venv/bin/activate
- Next, start the installation using
pip3
with:
pip3 install -U objection
- Once the dependencies are installed, the
objection
command should be available in yourPATH
. In some shells, it may be necessary to runhash -r
before the command will be available.
The most common error you are likely to face is one that might look as follows:
~ # pip install objection
Collecting objection
Could not find a version that satisfies the requirement objection (from versions: )
No matching distribution found for objection
This means that you are trying to install objection
using Python 2 and not Python 3. Either change your interpreter to Python 3, try and install using pip3
and not pip
or activate a new virtual environment.