Merge pull request #2 from meherett/axiom90/desktop

Desktop client app
talonlab · Nov 1, 2024 · 117e6ed · 117e6ed
2 parents 124cf60 + 2c22eff
commit 117e6ed
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,12 @@
-# Bitcoin Improvement Proposal - 0038 / BIP38
+<h1 align="center" style="border-bottom: none">
+    <img height="100" alt="BIP38" src="docs/static/svg/bip38.svg"><br>Bitcoin Improvement Proposal - 0038
+</h1>
+
+<p align="center">
+    <a href="https://github.com/meherett/python-bip38/releases" target="_blank">Releases</a> · <a href="https://talonlab.gitbook.io/bip38/manual" target="_blank">Manual</a> · <a href="https://bip38.readthedocs.io" target="_blank">API Docs</a> · <a href="#donations">Donation</a>
+</p>
+
+<div align="center">
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/meherett/python-bip38/build.yml)](https://github.com/meherett/python-bip38/actions/workflows/build.yml)
 [![PyPI Version](https://img.shields.io/pypi/v/bip38.svg?color=blue)](https://pypi.org/project/bip38)
@@ -7,10 +15,14 @@
 [![PyPI Python Version](https://img.shields.io/pypi/pyversions/bip38.svg)](https://pypi.org/project/bip38)
 [![Coverage Status](https://coveralls.io/repos/github/meherett/python-bip38/badge.svg?branch=master)](https://coveralls.io/github/meherett/python-bip38)
 
+</div>
+
 A Python library for the implementation of Bitcoin Improvement Proposal - 0038 / (BIP38) protocol.
 This library supports both [No EC-multiply](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki#encryption-when-ec-multiply-flag-is-not-used) and [EC-multiply](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki#encryption-when-ec-multiply-mode-is-used) modes and is compatible with over 150+ cryptocurrencies.
 It's specifically tailored for Pay-to-PubKey-Hash (P2PKH) address types.
 
+![Desktop Application](docs/static/gif/bip38.gif)
+
 For more info see the [Passphrase-protected private key - BIP38](https://en.bitcoin.it/wiki/BIP_0038) spec.
 
 ## Installation
@@ -417,7 +429,7 @@ BIP38 Decrypted: {
 To get started, just fork this repo, clone it locally, and run:
 
 ```
-pip install -e .[tests,docs]
+pip install -e .[desktop,tests,docs]
 ```
 
 ## Testing
@@ -450,9 +462,8 @@ This module supports more than 150+ cryptocurrencies, including the following:
 
 Buy me a coffee if You found this tool helpful:
 
-- **Bitcoin** - 12uaGVdX1t86FXLQ4yYPrRQDCK7xGGu82r
-- **Ethereum / Tether** - 0xCCAad7A87fd81553d0F93F743Fb4Fc6B213b228B
-- **Bitcoin / Ethereum / Tether** - With Unstoppable [hd.wallet](https://ud.me/hd.wallet)
+- **Bitcoin** - 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS
+- **Ethereum / ERC20** - 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B
 
 Thank you very much for your support.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -455,7 +455,7 @@ We welcome pull requests. To get started, just fork this `github repository <htt
 
 ::
 
-    pip install -e .[tests,docs]
+    pip install -e .[desktop,tests,docs]
 
 
 Testing

diff --git a/docs/static/gif/bip38.gif b/docs/static/gif/bip38.gif
diff --git a/docs/static/svg/bip38-full.svg b/docs/static/svg/bip38-full.svg
diff --git a/docs/static/svg/bip38.svg b/docs/static/svg/bip38.svg
diff --git a/requirements/desktop.txt b/requirements/desktop.txt
@@ -0,0 +1,2 @@
+PySide6==6.7.2
+cx-Freeze==7.2.0
diff --git a/setup.py b/setup.py
@@ -50,7 +50,8 @@ def get_requirements(name: str) -> List[str]:
     include_package_data=True,
     extras_require=dict(
         docs=get_requirements(name="requirements/docs"),
-        tests=get_requirements(name="requirements/tests")
+        tests=get_requirements(name="requirements/tests"),
+        desktop=get_requirements(name="requirements/desktop")
     ),
     classifiers=[
         "Development Status :: 5 - Production/Stable",
-Original file line number
+Diff line change
@@ Expand Up @@
     ::
-        pip install -e .[tests,docs]
+        pip install -e .[desktop,tests,docs]
     Testing
@@ Expand Down @@