Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added pip install iota-sdk to python readme as first option #1406

Merged
merged 7 commits into from
Oct 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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:
Thoralf-M marked this conversation as resolved.
Show resolved Hide resolved
Expand Down