From abfa3ad5928c1017e464758f8563948a28bc4b5a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrei=20B=C4=83ncioiu?= Date: Mon, 26 Aug 2024 14:28:07 +0300 Subject: [PATCH] Deprecate repository & package. --- README.md | 68 +------------------------------ multiversx_sdk_wallet/__init__.py | 4 ++ pyproject.toml | 5 ++- 3 files changed, 8 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 09f0303..7619b60 100644 --- a/README.md +++ b/README.md @@ -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://git@github.com/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 -``` diff --git a/multiversx_sdk_wallet/__init__.py b/multiversx_sdk_wallet/__init__.py index fcd2f97..ba5b560 100644 --- a/multiversx_sdk_wallet/__init__.py +++ b/multiversx_sdk_wallet/__init__.py @@ -1,3 +1,5 @@ +import warnings + from multiversx_sdk_wallet.mnemonic import Mnemonic from multiversx_sdk_wallet.user_keys import UserPublicKey, UserSecretKey from multiversx_sdk_wallet.user_pem import UserPEM @@ -9,4 +11,6 @@ from multiversx_sdk_wallet.validator_signer import ValidatorSigner from multiversx_sdk_wallet.validator_verifier import ValidatorVerifier +warnings.warn('This package is deprecated and will no longer be maintained. Instead, please use "multiversx-sdk".') + __all__ = ["UserSigner", "Mnemonic", "UserSecretKey", "UserPublicKey", "ValidatorSecretKey", "ValidatorPublicKey", "UserVerifier", "ValidatorSigner", "ValidatorVerifier", "UserWallet", "UserPEM"] diff --git a/pyproject.toml b/pyproject.toml index 6eef0f5..b49e2b6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,15 +7,16 @@ allow-direct-references = true [project] name = "multiversx-sdk-wallet" -version = "0.9.3" +version = "1.0.0" authors = [ { name="MultiversX" }, ] license = "MIT" -description = "Wallet & crypto components of MultiversX Python SDK." +description = "Deprecated. Instead, use multiversx-sdk." readme = "README.md" requires-python = ">=3.8" classifiers = [ + "Development Status :: 7 - Inactive", "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent",