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 docs for contract interactions using abi file through mxpy #980

Merged
merged 5 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
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
78 changes: 38 additions & 40 deletions docs/sdk-and-tools/overview.md

Large diffs are not rendered by default.

34 changes: 0 additions & 34 deletions docs/sdk-and-tools/sdk-py/configuring-mxpy.md

This file was deleted.

61 changes: 0 additions & 61 deletions docs/sdk-and-tools/sdk-py/deriving-the-wallet-pem-file.md

This file was deleted.

25 changes: 6 additions & 19 deletions docs/sdk-and-tools/sdk-py/installing-mxpy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,10 @@ Before installing **mxpy**, please make sure you have a working **Python 3** env

## **Install using pipx**

:::info
Keep in mind that installing using **pipx** is only available for **mxpy v9.2.0** or later.
:::

You'll need **pipx** installed on your machine. For more details on how to install **pipx** check out [**this page**](https://pipx.pypa.io/stable/#install-pipx).

:::note
If you've previously installed **mxpy** using **mxpy-up** and you'd like to switch to **pipx**, make sure to remove the old `mxpy` shortcut and virtual Python environment beforehand:
If you've previously installed **mxpy** using **mxpy-up**, we advise you to switch to **pipx**, but make sure to remove the old `mxpy` shortcut and virtual Python environment beforehand:

```sh
rm ~/multiversx-sdk/mxpy
Expand Down Expand Up @@ -63,27 +59,18 @@ To check that **mxpy** installed successfully you can run the following command:
mxpy --version
```

[comment]: # (mx-context-auto)

## **Upgrade mxpy using pipx**

To upgrade **mxpy** to a newer version you can simply run the following command:
Additionally, if you'd like to have shell completion for `bash` and `zsh`, run the following command, then restart the shell:

```sh
pipx upgrade multiversx-sdk-cli
activate-global-python-argcomplete
```

[comment]: # (mx-context-auto)

## **Install using mxpy-up**

Installing **mxpy** using **mxpy-up** is not recommended anymore. We recommend using **pipx** instead.
## **Upgrade mxpy using pipx**

If you've previously installed **mxpy** using the legacy **mxpy-up**, you should switch to the **pipx** approach. Make sure to remove the old `mxpy` shortcut and virtual Python environment beforehand:
To upgrade **mxpy** to a newer version, you can simply run the following command:

```sh
rm ~/multiversx-sdk/mxpy
rm -rf ~/multiversx-sdk/mxpy-venv
pipx upgrade multiversx-sdk-cli
```

Additionally, you might want to cleanup the shell profile files, to not alter anymore the `PATH` variable with respect to `~/multiversx-sdk`: `~/.profile`, `~/.bashrc` and / or `~/.zshrc`.
Loading
Loading