Skip to content

Commit

Permalink
Update Installation.md - minor formatting fixes (#970)
Browse files Browse the repository at this point in the history
minor formatting fixes

Signed-off-by: Sam Stepanyan <[email protected]>
  • Loading branch information
securestep9 authored Nov 28, 2024
1 parent d876e87 commit cec376a
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ Installing OWASP Nettacker using `pipx` is a convenient method for managing Pyth
Here’s how you can install OWASP Nettacker using `pipx`:

1. Install pipx using apt or pip


Using apt:
```
sudo apt update
Expand All @@ -67,7 +69,7 @@ python3 -m pip install --user pipx
python3 -m pipx ensurepath
```

2. Install nettacker using pipx
2. Install **nettacker** using pipx
```
pipx install nettacker
nettacker --help
Expand Down Expand Up @@ -107,20 +109,28 @@ nettacker --help

### Install Nettacker using Git Clone and Poetry

``` sudo apt update
sudo apt install python3-poetry git
git clone https://github.com/OWASP/Nettacker --depth 1
cd Nettacker
poetry install
poetry run nettacker --help
```
sudo apt update
sudo apt install python3-poetry git
git clone https://github.com/OWASP/Nettacker --depth 1
cd Nettacker
poetry install
poetry run nettacker --help
```

### What Happened to requirements.txt in Nettacker?

In recent updates to OWASP Nettacker, the project has transitioned away from using the traditional `requirements.txt` file for dependency management. Starting from version 0.4.0, Nettacker adopted Poetry as its package manager instead of the `requirements.txt` file. Poetry simplifies dependency management, handling both the installation of dependencies and packaging more efficiently.

Now, the dependencies for Nettacker are listed in `pyproject.toml`, which is a modern PEP 518 standard. `pyproject.toml` is also used by Poetry package manager, and the installation process follows a different approach:
You can install Nettacker directly from PyPI with the command `pip3 install nettacker` or if you have already cloned Nettacker git repo you can run `pip install .` inside the Nettacker folder.

You can install Nettacker directly from PyPI with the command:
`pip3 install nettacker`
or if you have already cloned Nettacker git repo you can run:

`pip install .`

inside the Nettacker folder.


To see the list of command options you can use:
Expand All @@ -135,11 +145,11 @@ or
nettacker -h
```


### Install Nettacker Using Docker

```
docker pull owasp/nettacker
docker run -it owasp/nettacker /bin/bash
```

For usage instructions and examples please read [Usage.md](Usage.md)
For usage instructions and examples please read [Usage.md](Usage.md)

0 comments on commit cec376a

Please sign in to comment.