From f54a375e0aac53ab2ad70d221f36be8a2abbb2b6 Mon Sep 17 00:00:00 2001 From: Shrey Kulshrestha <58223881+shreykul@users.noreply.github.com> Date: Mon, 9 Oct 2023 23:50:09 +0530 Subject: [PATCH] Added pip install iota-sdk to python readme as first option (#1406) * Added the pip install in readme. * added the link * correct * changed 3rd point * remove --------- Co-authored-by: Shreyansh Kulshrestha Co-authored-by: Thoralf-M <46689931+Thoralf-M@users.noreply.github.com> --- bindings/python/README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/bindings/python/README.md b/bindings/python/README.md index ab16526d66..496c8a57f3 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -8,6 +8,7 @@ Python binding to the [iota-sdk library](/README.md). - [Table of contents](#table-of-contents) - [Requirements](#requirements) - [Getting Started](#getting-started) + - [Install the IOTA SDK via pip](#install-iota-sdk-via-pip) - [Install the IOTA SDK](#install-the-iota-sdk) - [Client](#client-usage) - [Wallet](#wallet-usage) @@ -24,6 +25,34 @@ Python binding to the [iota-sdk library](/README.md). ## Getting Started +### Install IOTA SDK via pip + +1. (optional) Create a virtual environment and use it. On Linux and macOS, you can run the following commands: + + ```bash + python3 -m venv env + source env/bin/activate + ``` + + If you are using Windows, you should run the following instead: + + ```bash + python3 -m venv env + .\env\Scripts\activate + ``` + +2. Install the IOTA-SDK using pip: + + ```bash + pip install iota-sdk + ``` + +3. (optional) If you want to deactivate the virtual environment, run the following command: + + ```bash + deactivate + ``` + ### Install the IOTA SDK 1. Move to the Python bindings directory: @@ -43,7 +72,7 @@ Python binding to the [iota-sdk library](/README.md). ```bash python3 -m venv env - .\env\Scripts\activate` + .\env\Scripts\activate ``` 3. Install the required dependencies and build the wheel by running the following commands: