Skip to content

Commit

Permalink
Created mptsec as pip package
Browse files Browse the repository at this point in the history
  • Loading branch information
ByteSnipers committed Jan 25, 2025
1 parent 6048d5e commit 980a6e5
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 12 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# ChangeLog

### 0.7.45
- ADDED: mptsec is also available as PIP package

### 0.7.42
- CHANGE: Changed mpt package name to mptsec

### 0.7.41
- CHANGE: Added symlinks to available binaries and global TMP_BIN folder

Expand Down
59 changes: 48 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,49 @@ The mobile pentest toolkit (MPT) was presented on conference OWASP Bucharest App
* [Tales of Practical Android Penetration Testing
(Mobile Pentest Toolkit)](https://www.owasp.org/images/4/4b/OWASP-Tales-of-practical-penetration-testing.pdf)

### Installation using PIPX
# Installation

## Installation using PIPX (preferred installation method)
```
pipx install git+https://github.com/ByteSnipers/mobile-pentest-toolkit --include-deps
```
if required install pipx
1. install OS package `python-pipx` or `pipx`
- also possible to install using pip: `python3 -m pip install --user pipx`
2. `pipx ensurepath`

### 1. if required install pipx
```
# Python (pip)
python3 -m pip install --user pipx
# Debian/Ubuntu/Kali
sudo apt update
sudo apt install pipx
# Fedora
sudo dnf install pipx
# Arch Linux/Black Arch
sudo pacman -S python-pipx
# openSUSE
sudo zypper install pipx
```
### 2. ensure pipx path is set correctly
The pipx ensurepath command is used to ensure that the directory containing pipx's installed binaries is included in your system's `PATH` environment variable.
```
pipx ensurepath
```

## Installation using PIP
```
pip install mptsec
```
If `pip install mptsec` fails, you can isolate the installation using a virtual environment (venv) to avoid system-level conflicts.
```
python3 -m venv venv
source venv/bin/activate
pip install mptsec
```

# Update

### Update using PIPX
```
Expand All @@ -72,18 +107,20 @@ pipx install git+https://github.com/ByteSnipers/mobile-pentest-toolkit --include
mpt --update
```


# Uninstallation
### Uninstall using PIPX
```
pipx uninstall mptsec
```


### Install Dependencies (local usage)
### Uninstall using PIP
```
pip3 install -r requirements.txt
pip uninstall mptsec
```


# Configuration

### Alias pentest-dir

You can set this alias to quickly and easily navigate to your project directory based on the configuration in the `settings.json` file. Here’s how you can do it:
Expand Down Expand Up @@ -123,7 +160,7 @@ cp -r mpt/mpt-zsh-plugin/ ~/.oh-my-zsh/plugins/mpt
Enable MPT plugin in `.zshrc` by adding the fooling line `plugins=(mpt)`


### Start New Project
# Start New Project

1) Setup pentest environment and install required tools

Expand All @@ -138,7 +175,7 @@ mpt --setup <apk-file>
```


### Usage
# Usage
```
mpt.py <command> [options]
Expand Down
2 changes: 1 addition & 1 deletion mpt/console.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

from mpt import functions

__version__ = '0.7.44'
__version__ = '0.7.45'

from mpt import settings, logger
from mpt.config import Config
Expand Down

0 comments on commit 980a6e5

Please sign in to comment.