This repository has been archived by the owner on Aug 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #36 from multiversx/deprecation-26-1
Deprecate repository & package
- Loading branch information
Showing
3 changed files
with
8 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,5 @@ | ||
[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/) | ||
|
||
This project will be deprecated in the near future. All the functionality has been moved to the new [repository](https://github.com/multiversx/mx-sdk-py). | ||
This project is deprecated. All the functionality has been moved to the new [repository](https://github.com/multiversx/mx-sdk-py). | ||
|
||
The migration guide as a GitHub issue can be found [here](https://github.com/multiversx/mx-sdk-py/issues/41). | ||
|
||
# mx-sdk-py-wallet | ||
|
||
Wallet & crypto components of MultiversX Python SDK. | ||
|
||
## Distribution | ||
|
||
- GitHub: `git+https://[email protected]/multiversx/mx-sdk-py-wallet.git@v{Version}#egg=multiversx_sdk_wallet` | ||
- [PyPi](https://pypi.org/user/multiversx/) | ||
|
||
## Documentation | ||
|
||
[docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/erdpy/erdpy/) | ||
|
||
## Development setup | ||
|
||
### 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 `pyproject.toml`. | ||
|
||
If using VSCode, restart it or follow these steps: | ||
- `Ctrl + Shift + P` | ||
- _Select Interpreter_ | ||
- Choose `./venv/bin/python`. | ||
|
||
### Tests | ||
|
||
Run the tests as follows: | ||
|
||
``` | ||
pytest . | ||
``` | ||
|
||
### Linting | ||
|
||
First, install [`pyright`](https://github.com/microsoft/pyright) as follows: | ||
|
||
``` | ||
npm install --global pyright | ||
``` | ||
|
||
Run `pyright`: | ||
|
||
``` | ||
pyright | ||
``` | ||
|
||
Run `flake8`: | ||
|
||
``` | ||
flake8 multiversx_sdk_wallet | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters