Skip to content

Commit ce60702

Browse files
authored
Merge pull request #923 from OWASP/securestep9-docs-0.4.0-installation-patch-1
Update docs Installation.md for 0.4.0
2 parents 12170a3 + 3f1a861 commit ce60702

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

docs/Installation.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
### Supported Platforms
99

10-
OWASP Nettacker runs on Linux operating system (we recommend using the docker image to be able to run it on any OS). If you would like to run this on your machine you must install all dependencies and at least Python 3.9.2
10+
OWASP Nettacker runs on Linux operating system (we recommend using the docker image to be able to run it on any OS). If you would like to run this on your machine you must install all dependencies and at least Python 3.10
1111

12-
PLEASE NOTE: Starting from Nettacker version 0.0.3 the support for Python2 and Python <3.9 has been dropped. If you have a requirement to use Nettacker on Python 2.x or 3.0-3.7 you can use the legacy version of Nettacker [v0.0.2](https://github.com/OWASP/Nettacker/releases/tag/0.0.2)
12+
PLEASE NOTE: Starting from Nettacker version 0.3.1 the support for Python2 and Python <3.10 has been dropped. If you have a requirement to use Nettacker on Python 2.x or 3.0-3.9 you can use the legacy version of Nettacker [v0.0.2](https://github.com/OWASP/Nettacker/releases/tag/0.0.2)
1313

1414
### Dependencies
1515

16-
OWASP Nettacker v0.0.3 has dependencies on the following libraries and tools:
16+
OWASP Nettacker has dependencies on the following libraries and tools:
1717

1818
* libcurl4-openssl-dev
1919
* libcurl4-gnutls-dev
@@ -27,8 +27,6 @@ OWASP Nettacker v0.0.3 has dependencies on the following libraries and tools:
2727
* gcc
2828
* git
2929

30-
A `requirements-apt-get.txt` file is included with Nettacker to assist the installation of the above libraries on Debian-based OS using `apt-get`. If you are using Windows, Mac or non-Debian-based Linux distro you need to install the corresponding dependencies for your operating system first.
31-
3230
Before using this software, please install the requirements following the commands below:
3331

3432

@@ -38,24 +36,29 @@ apt-get update
3836
apt-get install -y python3 python3-dev python3-pip
3937
pip3 install --upgrade pip3
4038
```
41-
Install Requirements.
39+
40+
Starting from version 0.4.0 Nettacker is now using Poetry Package Manager and can be installed directly from PyPI.
4241

4342
```
44-
apt-get update
45-
apt-get install -y < requirements-apt-get.txt
46-
pip3 install --upgrade pip
47-
pip3 install -r requirements.txt
48-
pip3 install -r requirements-dev.txt
43+
python3 -m venv venv
44+
. venv/bin/activate
45+
pip3 install nettacker
46+
nettacker --help
4947
```
5048

51-
PLEASE NOTE: Python version 3.9.2 or higher is required to run Nettacker v.0.0.3. You can check the version of Python3 installed by running:
49+
PLEASE NOTE: Python version 3.10 or higher is required to run Nettacker. You can check the version of Python3 installed by running:
5250

5351
```
5452
python3 -V
5553
```
5654

57-
If you have Python v3.9.2 or higher you should be able to run OWASP Nettacker via command `python3 nettacker.py`
55+
If you have Python 3.10 or higher you should be able to run OWASP Nettacker via command:
56+
57+
`python3 nettacker.py`
58+
59+
or simply
5860

61+
`nettacker`
5962

6063
### Make your life easier using docker
6164
To run the API server, just run `docker-compose up`. if you need to run via command line use the commands below.

0 commit comments

Comments
 (0)