Skip to content
This repository has been archived by the owner on Aug 26, 2024. It is now read-only.

Commit

Permalink
Merge pull request #36 from multiversx/deprecation-26-1
Browse files Browse the repository at this point in the history
Deprecate repository & package
  • Loading branch information
andreibancioiu authored Aug 26, 2024
2 parents 31b7f5b + abfa3ad commit 8c47f1b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 69 deletions.
68 changes: 1 addition & 67 deletions README.md
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
```
4 changes: 4 additions & 0 deletions multiversx_sdk_wallet/__init__.py
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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"]
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 8c47f1b

Please sign in to comment.