Skip to content

Commit cec376a

Browse files
authored
Update Installation.md - minor formatting fixes (#970)
minor formatting fixes Signed-off-by: Sam Stepanyan <[email protected]>
1 parent d876e87 commit cec376a

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

docs/Installation.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ Installing OWASP Nettacker using `pipx` is a convenient method for managing Pyth
5353
Here’s how you can install OWASP Nettacker using `pipx`:
5454

5555
1. Install pipx using apt or pip
56+
57+
5658
Using apt:
5759
```
5860
sudo apt update
@@ -67,7 +69,7 @@ python3 -m pip install --user pipx
6769
python3 -m pipx ensurepath
6870
```
6971

70-
2. Install nettacker using pipx
72+
2. Install **nettacker** using pipx
7173
```
7274
pipx install nettacker
7375
nettacker --help
@@ -107,20 +109,28 @@ nettacker --help
107109

108110
### Install Nettacker using Git Clone and Poetry
109111

110-
``` sudo apt update
111-
sudo apt install python3-poetry git
112-
git clone https://github.com/OWASP/Nettacker --depth 1
113-
cd Nettacker
114-
poetry install
115-
poetry run nettacker --help
112+
```
113+
sudo apt update
114+
sudo apt install python3-poetry git
115+
git clone https://github.com/OWASP/Nettacker --depth 1
116+
cd Nettacker
117+
poetry install
118+
poetry run nettacker --help
116119
```
117120

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

120123
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.
121124

122125
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:
123-
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.
126+
127+
You can install Nettacker directly from PyPI with the command:
128+
`pip3 install nettacker`
129+
or if you have already cloned Nettacker git repo you can run:
130+
131+
`pip install .`
132+
133+
inside the Nettacker folder.
124134

125135

126136
To see the list of command options you can use:
@@ -135,11 +145,11 @@ or
135145
nettacker -h
136146
```
137147

138-
139148
### Install Nettacker Using Docker
149+
140150
```
141151
docker pull owasp/nettacker
142152
docker run -it owasp/nettacker /bin/bash
143153
```
144154

145-
For usage instructions and examples please read [Usage.md](Usage.md)
155+
For usage instructions and examples please read [Usage.md](Usage.md)

0 commit comments

Comments
 (0)