https://github.com/multiversx/mx-sdk-py-cli
Python Command Line Tools and SDK for interacting with the MultiversX blockchain and dApps.
https://github.com/multiversx/mx-sdk-py-cli
Last synced: about 2 months ago
JSON representation
Python Command Line Tools and SDK for interacting with the MultiversX blockchain and dApps.
- Host: GitHub
- URL: https://github.com/multiversx/mx-sdk-py-cli
- Owner: multiversx
- License: other
- Created: 2021-05-27T12:46:50.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T12:57:48.000Z (3 months ago)
- Last Synced: 2025-01-30T13:45:21.006Z (3 months ago)
- Language: Python
- Homepage:
- Size: 6.91 MB
- Stars: 49
- Watchers: 21
- Forks: 36
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-multiversx-dev-resources - Python SDK - Command line tools and Python SDK for interacting with the MultiversX Network and MultiversX Smart Contracts (MultiversX official / SDKs and dev tools)
README
# Description
Python Command Line Tools for interacting with MultiversX.
## Documentation
[docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/sdk-py/)
## CLI
[CLI](CLI.md)
## Distribution
[pipx](https://docs.multiversx.com/sdk-and-tools/sdk-py/installing-mxpy/) [(PyPi)](https://pypi.org/project/multiversx-sdk-cli/#history)
## Development setup
Clone this repository and cd into it:
```
git clone https://github.com/multiversx/mx-sdk-py-cli.git
cd mx-sdk-py-cli
```
### Virtual environment
Create a virtual environment and install the dependencies:
```
python3 -m venv ./venv
source ./venv/bin/activate
pip install -r ./requirements.txt --upgrade
```
Install development dependencies, as well:
```
pip install -r ./requirements-dev.txt --upgrade
```
Above, `requirements.txt` should mirror the **dependencies** section of `setup.py`.
If using VSCode, restart it or follow these steps:
- `Ctrl + Shift + P`
- _Select Interpreter_
- Choose `./venv/bin/python`.
### Using your local `mxpy`
If you want to test the modifications you locally made to `mxpy`, set `PYTHONPATH` with the path to your local repository path.
For example, if you cloned the repository at `~/mx-sdk-py-cli`, run:
```
export PYTHONPATH="~/mx-sdk-py-cli"
```
Then `mxpy` will use the code in your local repository.