Skip to content

Commit

Permalink
Added pip install iota-sdk to python readme as first option (#1406)
Browse files Browse the repository at this point in the history
* Added the pip install in readme.

* added the link

* correct

* changed 3rd point

* remove

---------

Co-authored-by: Shreyansh Kulshrestha <[email protected]>
Co-authored-by: Thoralf-M <[email protected]>
  • Loading branch information
3 people authored Oct 9, 2023
1 parent 904fded commit f54a375
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion bindings/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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:
Expand All @@ -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:
Expand Down

0 comments on commit f54a375

Please sign in to comment.