Fix buggy testing process of test_from_xpublic_key

.github/workflows/pythonpackage.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
     - uses: actions/checkout@master
@@ -25,6 +25,6 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[tests]
+        pip install -e .[cli,tests,docs]
     - name: Test with pytest
       run: pytest

.travis.yml

@@ -1,11 +1,9 @@
 language: python
-dist: xenial
-sudo: true
+dist: bionic
+before_install:
+  - python -m pip install --upgrade pip
 install:
-  - sudo add-apt-repository -y ppa:deadsnakes/ppa
-  - sudo apt-get update
-  - sudo apt-get install -y python$TRAVIS_PYTHON_VERSION-dev
-  - pip install -e .[tests,docs] tox-travis coveralls
+  - pip install -e .[cli,tests,docs] tox-travis coveralls
 matrix:
   include:
   - name: "3.6"
@@ -16,5 +14,7 @@ matrix:
     python: 3.8
   - name: "3.9"
     python: 3.9
-script: pytest
-after_success: if [ "${TRAVIS_PYTHON_VERSION}" == "3.9" ]; then coveralls; fi;
+  - name: "3.10"
+    python: 3.10
+script: tox
+after_success: if [ "${TRAVIS_PYTHON_VERSION}" == "3.10" ]; then coveralls; fi;

README.md

@@ -1,14 +1,16 @@
-
 # Hierarchical Deterministic Wallet
 
-[![Build Status](https://travis-ci.org/meherett/python-hdwallet.svg?branch=master)](https://travis-ci.org/meherett/python-hdwallet?branch=master)
+[![Build Status](https://app.travis-ci.com/meherett/python-hdwallet.svg?branch=master)](https://app.travis-ci.com/meherett/python-hdwallet)
 [![PyPI Version](https://img.shields.io/pypi/v/hdwallet.svg?color=blue)](https://pypi.org/project/hdwallet)
-[![Documentation Status](https://readthedocs.org/projects/hdwallet/badge/?version=master)](https://hdwallet.readthedocs.io/en/master/?badge=master)
+[![Documentation Status](https://readthedocs.org/projects/hdwallet/badge/?version=master)](https://hdwallet.readthedocs.io)
+[![PyPI License](https://img.shields.io/pypi/l/hdwallet?color=black)](https://pypi.org/project/hdwallet)
 [![PyPI Python Version](https://img.shields.io/pypi/pyversions/hdwallet.svg)](https://pypi.org/project/hdwallet)
-[![Coverage Status](https://coveralls.io/repos/github/meherett/python-hdwallet/badge.svg?branch=master)](https://coveralls.io/github/meherett/python-hdwallet?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/meherett/python-hdwallet/badge.svg?branch=master)](https://coveralls.io/github/meherett/python-hdwallet)
 
 Python-based library for the implementation of a hierarchical deterministic wallet generator for more than 140+ multiple cryptocurrencies.
-It allows the handling of multiple coins, multiple accounts, external and internal chains per account and millions of addresses per the chain.
+It allows the handling of multiple coins, multiple accounts, external and internal chains per account and millions of addresses per chain.
+
+<img src="https://github.com/meherett/python-hdwallet/blob/master/docs/static/gif/hdwallet.gif"/>
 
 For more info see the BIP specs.
 
@@ -19,17 +21,23 @@ For more info see the BIP specs.
 | [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)  | Hierarchical Deterministic Wallets                         |
 | [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)  | Multi-Account Hierarchy for Deterministic Wallets          |
 | [BIP49](https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki)  | Derivation scheme for P2WPKH-nested-in-P2SH based accounts |
-| [BIP84](https://github.com/bitcoin/bips/blob/master/bip-0048.mediawiki)  | Derivation scheme for P2WPKH based accounts                |
-| [BIP141](https://github.com/bitcoin/bips/blob/master/bip-0014.mediawiki) | Segregated Witness (Consensus layer)                       |
+| [BIP84](https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki)  | Derivation scheme for P2WPKH based accounts                |
+| [BIP141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki) | Segregated Witness (Consensus layer)                       |
 
 ## Installation
 
-PIP to install `hdwallet` globally, for Linux `sudo` may be required:
+The easiest way to install `hdwallet` is via pip:
 
 ```
 pip install hdwallet
 ```
 
+To install `hdwallet` command line interface globally, for Linux `sudo` may be required:
+
+```
+pip install hdwallet[cli]
+```
+
 If you want to run the latest version of the code, you can install from the git:
 
 ```
@@ -40,14 +48,14 @@ For the versions available, see the [tags on this repository](https://github.com
 
 ## Quick Usage
 
-Simple Bitcoin mainnet hierarchical deterministic wallet generator:
+Simple Bitcoin mainnet HDWallet generator:
 
 ```python
 #!/usr/bin/env python3
 
 from hdwallet import HDWallet
 from hdwallet.utils import generate_entropy
-from hdwallet.symbols import BTC
+from hdwallet.symbols import BTC as SYMBOL
 from typing import Optional
 
 import json
@@ -62,7 +70,7 @@ ENTROPY: str = generate_entropy(strength=STRENGTH)
 PASSPHRASE: Optional[str] = None  # "meherett"
 
 # Initialize Bitcoin mainnet HDWallet
-hdwallet: HDWallet = HDWallet(symbol=BTC)
+hdwallet: HDWallet = HDWallet(symbol=SYMBOL, use_default_path=False)
 # Get Bitcoin HDWallet from entropy
 hdwallet.from_entropy(
     entropy=ENTROPY, language=LANGUAGE, passphrase=PASSPHRASE
@@ -168,7 +176,7 @@ for address_index in range(10):
 
 ```shell script
 Mnemonic: bright demand olive glance crater key head glory quantum leisure intact age
-Base HD Path:  m/44'/60'/0'/0/{address_index} 
+Base HD Path:  m/44'/60'/0'/0/{address_index}
 
 (0) m/44'/60'/0'/0/0 0x3a149f0c5dc5c0F1E29e573215C23710dE9c4f87 0xa45f9af43912fdd5e88c492226be082029f257681d4b3e73b68be535d2fb0526
 (1) m/44'/60'/0'/0/1 0x9e8A4fD9bA74DbB0c7F465EF56b47489793AA102 0x6e5ab2a3ae20c7b3a1c0645b03689e88e8cdff16f6a39d6a420bfebc20e8a941
@@ -185,18 +193,37 @@ Base HD Path:  m/44'/60'/0'/0/{address_index}
 
 [Click this to see more examples :)](https://github.com/meherett/python-hdwallet/blob/master/examples)
 
+## Development
+
+To get started, just fork this repo, clone it locally, and run:
+
+```
+pip install -e .[cli,tests,docs] -r requirements.txt
+```
+
+## Testing
+
+You can run the tests with:
+
+```
+pytest
+```
+
+Or use `tox` to run the complete suite against the full set of build targets, or pytest to run specific 
+tests against a specific version of Python.
+
 ## Contributing
 
-Feel free to open an [issue](https://github.com/meherett/hdwallet/issues) if you find a problem, 
-or a pull request if you've solved an issue. And also any help in testing, development, 
-documentation and other tasks is highly appreciated and useful to the project. 
+Feel free to open an [issue](https://github.com/meherett/hdwallet/issues) if you find a problem,
+or a pull request if you've solved an issue. And also any help in testing, development,
+documentation and other tasks is highly appreciated and useful to the project.
 There are tasks for contributors of all experience levels.
 
 For more information, see the [CONTRIBUTING.md](https://github.com/meherett/hdwallet/blob/master/CONTRIBUTING.md) file.
 
 ## Available Cryptocurrencies
 
-This library simplifies the process of creating a new HDWallet's for:
+This library simplifies the process of creating a new hierarchical deterministic wallets for:
 
 | Cryptocurrencies                                                  | Symbols              | Mainnet | Testnet | Segwit | Coin Type | Default Paths        |
 | :---------------------------------------------------------------- | :------------------: | :-----: | :-----: | :----: | :-------: | :------------------: |
@@ -323,6 +350,7 @@ This library simplifies the process of creating a new HDWallet's for:
 | Syscoin                                                           | `SYS`                | Yes     | No      | Yes    | 57        | `m/44'/57'/0'/0/0`   |
 | TOA Coin                                                          | `TOA`                | Yes     | No      | No     | 159       | `m/44'/159'/0'/0/0`  |
 | Thought AI                                                        | `THT`                | Yes     | No      | No     | 502       | `m/44'/502'/0'/0/0`  |
+| [Tron](https://github.com/tronprotocol/java-tron)                 | `TRX`                | Yes     | No      | No     | 195       | `m/44'/195'/0'/0/0`  |
 | Twins                                                             | `TWINS`, `TWINSTEST` | Yes     | Yes     | No     | 970       | `m/44'/970'/0'/0/0`  |
 | Ultimate Secure Cash                                              | `USC`                | Yes     | No      | No     | 112       | `m/44'/112'/0'/0/0`  |
 | Unobtanium                                                        | `UNO`                | Yes     | No      | No     | 92        | `m/44'/92'/0'/0/0`   |
@@ -337,24 +365,17 @@ This library simplifies the process of creating a new HDWallet's for:
 | XUEZ                                                              | `XUEZ`               | Yes     | No      | No     | 225       | `m/44'/225'/0'/0/0`  |
 | [XinFin](https://github.com/XinFinOrg/XDPoSChain)                 | `XDC`                | Yes     | No      | Yes    | 550       | `m/44'/550'/0'/0/0`  |
 | ZClassic                                                          | `ZCL`                | Yes     | No      | No     | 147       | `m/44'/147'/0'/0/0`  |
-| Zcash                                                             | `ZEC`                | Yes     | No      | No     | 133       | `m/44'/133'/0'/0/0`  |
+| [Zcash](https://github.com/zcash/zcash)                           | `ZEC`, `ZECTEST`     | Yes     | Yes     | No     | 133       | `m/44'/133'/0'/0/0`  |
 | Zencash                                                           | `ZEN`                | Yes     | No      | No     | 121       | `m/44'/121'/0'/0/0`  |
 
 ## Donations
 
-If You found this tool helpful consider making a donation:  
+If You found this tool helpful consider making a donation:
 
-Ethereum (ETH) or Tether (USDT-ERC20) address: 
-
-```text
-0x342798bbe9731a91e0557fa8ab0bce1eae6d6ae3
-```
-
-Bitcoin (BTC) address: 
-
-```text
-3GGNPvgbSpMHShcaZJGDXQn5wUJyTz7uoC
-```
+| Coins                         | Addresses                                  |
+| ----------------------------- | :----------------------------------------: |
+| Bitcoin `BTC`                 | 3GGNPvgbSpMHShcaZJGDXQn5wUJyTz7uoC         |
+| Ethereum `ETH`, Tether `USDT` | 0x342798bbe9731a91e0557fa8ab0bce1eae6d6ae3 |
 
 ## License
 

docs/cli.rst

@@ -0,0 +1,10 @@
+============================
+Command Line Interface (CLI)
+============================
+
+.. image:: static/gif/hdwallet.gif
+   :alt: HDWallet CLI
+
+.. click:: hdwallet.cli.__main__:main
+  :prog: hdwallet
+  :show-nested:

docs/conf.py

@@ -14,6 +14,9 @@
 import sys
 import datetime
 
+from hdwallet import (
+    __version__, __author__
+)
 
 sys.path.insert(0, os.path.abspath("../.."))
 sys.path.insert(1, os.path.abspath("./extensions"))
@@ -22,11 +25,11 @@
 # -- Project information -----------------------------------------------------
 
 project = "HDWallet"
-copyright = f"{datetime.datetime.now().year}, Meheret Tesfaye Batu"
-author = "Meheret Tesfaye"
+copyright = f"{datetime.datetime.now().year}, {__author__}"
+author = __author__
 
 # The full version, including alpha/beta/rc tags
-release = "1.3.0"
+release = __version__
 
 # The master toctree document.
 master_doc = "toctree"
@@ -37,7 +40,8 @@
 # extensions coming with Sphinx (named "sphinx.ext.*") or your custom
 # ones.
 extensions = [
-    "sphinx.ext.autodoc"
+    "sphinx.ext.autodoc",
+    "sphinx_click.ext"
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -52,15 +56,15 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 # Product logo name
 # html_logo = "static/png/hdwallet.png"
 # Theme options
 html_theme_options = {
     # "canonical_url": "",
     # "analytics_id": "UA-XXXXXXX-1",  #  Provided by Google in your dashboard
-    "logo_only": False,
-    "display_version": True,
+    # "logo_only": False,
+    # "display_version": True,
     # "prev_next_buttons_location": "bottom",
     # "style_external_links": False,
     # "vcs_pageview_mode": "",
@@ -71,12 +75,26 @@
     # "navigation_depth": 4,
     # "includehidden": True,
     # "titles_only": False
+
+    # "light_css_variables": {
+        # "color-brand-primary": "darkblue",
+        # "color-brand-content": "darkblue",
+        # "color-admonition-background": "black",
+    # },
+    # "dark_css_variables": {
+    #     "color-brand-primary": "green",
+    #     "color-brand-content": "green",
+        # "color-admonition-background": "white",
+    # },
+    # "sidebar_hide_name": True,
+    # "navigation_with_keys": True,
+    # "announcement": "<em>Important</em> announcement!",
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["static", "static/css"]
+html_static_path = ["static", "static/css", "static/gif"]
 
 # Autodoc member order
 autodoc_member_order = "bysource"

docs/cryptocurrencies.rst

@@ -1,11 +1,15 @@
 :orphan:
 
-==========================
-Available Cryptocurrencies
-==========================
+================
+Cryptocurrencies
+================
 
 This library simplifies the process of generating a new HDWallet's for:
 
+.. note::
+
+    All Cryptocurrencies testnet networks default paths are set to ``m/44'/1'/0'/0/0`` value.
+
 .. list-table::
    :widths: 25 25 25 25 15 25 50
    :header-rows: 1
@@ -878,6 +882,13 @@ This library simplifies the process of generating a new HDWallet's for:
      - No
      - 502
      - m/44'/502'/0'/0/0
+   * - `Tron <https://github.com/tronprotocol/java-tron>`_
+     - TRX
+     - Yes
+     - No
+     - No
+     - 195
+     - m/44'/195'/0'/0/0
    * - Twins
      - TWINS, TWINSTEST
      - Yes
@@ -977,9 +988,9 @@ This library simplifies the process of generating a new HDWallet's for:
      - 147
      - m/44'/147'/0'/0/0
    * - Zcash
-     - ZEC
+     - ZEC, ZECTEST
+     - Yes
      - Yes
-     - No
      - No
      - 133
      - m/44'/133'/0'/0/0
@@ -990,5 +1001,3 @@ This library simplifies the process of generating a new HDWallet's for:
      - No
      - 121
      - m/44'/121'/0'/0/0
-
-**NOTICE:** All Cryptocurrencies testnet networks default paths are set to **`m/44'/1'/0'/0/0`** value.