From df1a12c9d032fd4dfe1d818b3ce32ea3efb50e0e Mon Sep 17 00:00:00 2001 From: Sam Stepanyan Date: Fri, 27 Sep 2024 04:01:16 +0100 Subject: [PATCH 1/3] Update docs Installation.md for 0.4.0 Updated docs to have the correct installation method using 'pip3 install nettacker' command Signed-off-by: Sam Stepanyan --- docs/Installation.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index 467310b0e..016872846 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -7,13 +7,13 @@ ### Supported Platforms -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 +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 -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) +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) ### Dependencies -OWASP Nettacker v0.0.3 has dependencies on the following libraries and tools: +OWASP Nettacker has dependencies on the following libraries and tools: * libcurl4-openssl-dev * libcurl4-gnutls-dev @@ -27,8 +27,6 @@ OWASP Nettacker v0.0.3 has dependencies on the following libraries and tools: * gcc * git -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. - Before using this software, please install the requirements following the commands below: @@ -38,24 +36,29 @@ apt-get update apt-get install -y python3 python3-dev python3-pip pip3 install --upgrade pip3 ``` -Install Requirements. + +Starting from version 0.4.0 Nettacker is now using Poetry Package Manager and can be installed directly from PyPI. ``` -apt-get update -apt-get install -y < requirements-apt-get.txt -pip3 install --upgrade pip -pip3 install -r requirements.txt -pip3 install -r requirements-dev.txt +python3 -m venv venv +. venv/bin/activate +pip3 install nettacker +nettacker --help ``` -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: +PLEASE NOTE: Python version 3.10.15 or higher is required to run Nettacker. You can check the version of Python3 installed by running: ``` python3 -V ``` -If you have Python v3.9.2 or higher you should be able to run OWASP Nettacker via command `python3 nettacker.py` +If you have Python v3.10.15 or higher you should be able to run OWASP Nettacker via command: + +`python3 nettacker.py` + +or simply +`nettacker` ### Make your life easier using docker To run the API server, just run `docker-compose up`. if you need to run via command line use the commands below. From 3131ab00933a3368c926cdf942656c65a2932122 Mon Sep 17 00:00:00 2001 From: Sam Stepanyan Date: Fri, 27 Sep 2024 15:20:51 +0100 Subject: [PATCH 2/3] Update docs/Installation.md Co-authored-by: Arkadii Yakovets <2201626+arkid15r@users.noreply.github.com> Signed-off-by: Sam Stepanyan --- docs/Installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Installation.md b/docs/Installation.md index 016872846..b669a7a93 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -46,7 +46,7 @@ pip3 install nettacker nettacker --help ``` -PLEASE NOTE: Python version 3.10.15 or higher is required to run Nettacker. You can check the version of Python3 installed by running: +PLEASE NOTE: Python version 3.10 or higher is required to run Nettacker. You can check the version of Python3 installed by running: ``` python3 -V From 3f1a8612008f1c705a020d14ec7bdd835313841d Mon Sep 17 00:00:00 2001 From: Sam Stepanyan Date: Fri, 27 Sep 2024 15:20:58 +0100 Subject: [PATCH 3/3] Update docs/Installation.md Co-authored-by: Arkadii Yakovets <2201626+arkid15r@users.noreply.github.com> Signed-off-by: Sam Stepanyan --- docs/Installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Installation.md b/docs/Installation.md index b669a7a93..634c39c1c 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -52,7 +52,7 @@ PLEASE NOTE: Python version 3.10 or higher is required to run Nettacker. You ca python3 -V ``` -If you have Python v3.10.15 or higher you should be able to run OWASP Nettacker via command: +If you have Python 3.10 or higher you should be able to run OWASP Nettacker via command: `python3 nettacker.py`