Merge branch 'fix-passphrase'

Author: pjkundert

GNUmakefile

@@ -25,7 +25,7 @@ help:
 	@echo "GNUmakefile for cpppo.  Targets:"
 	@echo "  help			This help"
 	@echo "  test			Run unit tests under Python3"
-	@echo "  build			Build dist wheel and gui under Python3"
+	@echo "  build			Build dist wheel and app under Python3"
 	@echo "  install		Install in /usr/local for Python3"
 	@echo "  clean			Remove build artifacts"
 	@echo "  upload			Upload new version to pypi (package maintainer only)"
@@ -34,10 +34,6 @@ test:
 	$(PY3TEST)
 
 
-doctest:
-	$(PY3TEST) --doctest-modules
-
-
 analyze:
 	flake8 -j 1 --max-line-length=200 \
 	  --ignore=W503,E201,E202,E221,E223,E226,E231,E241,E242,E251,E265,E272,E274 \
@@ -52,7 +48,7 @@ build-check:
 	    || ( echo "\n*** Missing Python modules; run:\n\n        $(PY3) -m pip install --upgrade pip setuptools wheel build\n" \
 	        && false )
 
-build:		clean wheel gui
+build:		clean wheel app
 
 wheel:		dist/slip39-$(VERSION)-py3-none-any.whl
 
@@ -64,8 +60,8 @@ dist/slip39-$(VERSION)-py3-none-any.whl: build-check FORCE
 install:	dist/slip39-$(VERSION)-py3-none-any.whl FORCE
 	$(PY3) -m pip install --force-reinstall $^[gui,serial,json]
 
-# Generate, Sign and Zip the gui SLIP39.app package
-gui:		dist/SLIP39.app-$(VERSION).zip
+# Generate, Sign and Zip the macOS SLIP39.app GUI package
+app:		dist/SLIP39.app-$(VERSION).zip
 
 #(cd dist; zip -r SLIP39.app-$(VERSION).zip SLIP39.app)
 # Create a ZIP archive suitable for notarization.

README.org

@@ -143,19 +143,19 @@ by entering the mnemonics right on the device.
    instead), add a =-v= (to see it logged in a tabular format), or =--text= to have it printed to
    stdout in full lines (ie. for pipelining to other programs).
 
-** The MacOS =SLIP39.app= GUI
+** The macOS =SLIP39.app= GUI App
 
-   If you prefer a graphical user-interface, try the MacOS app.  You can run it directly if you
+   If you prefer a graphical user-interface, try the macOS app.  You can run it directly if you
    install Python 3.9+ from [[https://python.org/downloads][python.org/downlaods]] or using homebrew =brew install [email protected]= (or
    higher, eg. [email protected]=).  Then, start the GUI in a variety of ways:
 
    #+LATEX: {\scriptsize
    #+BEGIN_EXAMPLE
-   slip39-App
-   python -m slip39.App
+   slip39-gui
+   python -m slip39.gui
    #+END_EXAMPLE
 
-   Alternatively, download and install the MacOS App: [[https://github.com/pjkundert/python-slip39/releases/latest][github.com/pjkundert/python-slip-39/releases]].
+   Alternatively, download and install the macOS GUI App: [[https://github.com/pjkundert/python-slip39/releases/latest][github.com/pjkundert/python-slip-39/releases]].
 
    You will need to authorize it to run in System Preferences / Security & Privacy / Privacy.
 
@@ -1060,7 +1060,7 @@ by entering the mnemonics right on the device.
   and using [[https://www.python.org/downloads/][the official python.org/downloads installer]].
 
   Either of these methods will get you a =python3= executable running version 3.9+, usable for
-  running the =slip39= module, and the =slip39.App= GUI.
+  running the =slip39= module, and the =slip39.gui= GUI.
 
 ** The =slip39= Module
 
@@ -1078,14 +1078,14 @@ by entering the mnemonics right on the device.
    : $ python3 -m pip install slip39[gui]
 
    Then, there are several ways to run the GUI:
-   : $ python3 -m slip39.App     # Execute the python slip39.App module main method
-   : $ slip39-App                # Run the script provided by the slip39 module
+   : $ python3 -m slip39.gui     # Execute the python slip39.gui module main method
+   : $ slip39-gui                # Run the main function provided by the slip39.gui module
 
-*** The MacOS =SLIP39.app= GUI
+*** The macOS =SLIP39.app= GUI
 
-    You can build the native MacOS =SLIP39.app=.
+    You can build the native macOS =SLIP39.app= App.
 
-    This requires the official python.org/downloads installer; the homebrew [email protected] will not
+    This requires the official [[https://python.org/downloads][python.org/downloads]] installer; the homebrew [email protected] will not
     work for building the native app using either =PyInstaller=. (The =py2app= approach doesn't work
     in either version of Python).
 

README.pdf

@@ -2,6 +2,6 @@
 
 import sys
 
-from slip39.App.main import main
+from slip39.gui.main import main
 
 sys.exit( main() )

README.txt

@@ -0,0 +1,47 @@
+#+title: SLIP39 macOS App
+#+date: 2022-02-02 22:22:00
+#+draft: false
+#+EXPORT_FILE_NAME: macOS.pdf
+#+STARTUP: org-startup-with-inline-images inlineimages
+#+STARTUP: org-latex-tables-centered nil
+#+OPTIONS: ^:nil # Disable sub/superscripting with bare _; _{...} still works
+#+OPTIONS: toc:nil
+
+#+BEGIN_SRC emacs-lisp :noweb no-export :exports results
+;; Tables not centered
+(
+ setq org-latex-tables-centered nil
+      org-src-preserve-indentation t
+      org-edit-src-content-indentation 0
+)
+nil
+#+END_SRC
+
+#+RESULTS:
+
+#+BEGIN_ABSTRACT
+Creating Ethereum, Bitcoin and other accounts is complex and fraught with potential for loss of funds.
+
+All Crypto wallets start with a "Seed": a large, random number that is used to generate all of the
+actual Bitcoin, Ethereum, etc. wallets.
+
+The best practice for using these wallets is to load this "Seed" into a secure hardware device, like
+a Trezor hardware wallet.
+#+END_ABSTRACT
+#+TOC: headlines 2
+
+* Security with Availability
+
+  For both BIP-39 and SLIP-39, a 128-bit random "seed" is the source of an unlimited sequence of
+  Ethereum HD Wallet accounts.  Anyone who can obtain this seed gains control of all Ethereum,
+  Bitcoin (and other) accounts derived from it, so it must be securely stored.
+
+  Losing this seed means that all of the HD Wallet accounts are permanently lost.  Therefore, it
+  must be backed up reliably, and be readily accessible.
+
+  Therefore, we must:
+
+  - Ensure that nobody untrustworthy can recover the seed, but
+  - Store the seed in many places with several (some perhaps untrustworthy) people.
+
+  How can we address these conflicting requirements?

SLIP39.py

@@ -0,0 +1,43 @@
+                           ━━━━━━━━━━━━━━━━━━
+                            SLIP39 MACOS APP
+
+                             Perry Kundert
+                           ━━━━━━━━━━━━━━━━━━
+
+
+                          2022-02-02 22:22:00
+
+
+Creating Ethereum, Bitcoin and other accounts is complex and fraught
+with potential for loss of funds.
+
+All Crypto wallets start with a "Seed": a large, random number that is
+used to generate all of the actual Bitcoin, Ethereum, etc. wallets.
+
+The best practice for using these wallets is to load this "Seed" into a
+secure hardware device, like a Trezor hardware wallet.
+Table of Contents
+─────────────────
+
+1. Security with Availability
+
+
+1 Security with Availability
+════════════════════════════
+
+  For both BIP-39 and SLIP-39, a 128-bit random "seed" is the source of
+  an unlimited sequence of Ethereum HD Wallet accounts.  Anyone who can
+  obtain this seed gains control of all Ethereum, Bitcoin (and other)
+  accounts derived from it, so it must be securely stored.
+
+  Losing this seed means that all of the HD Wallet accounts are
+  permanently lost.  Therefore, it must be backed up reliably, and be
+  readily accessible.
+
+  Therefore, we must:
+
+  • Ensure that nobody untrustworthy can recover the seed, but
+  • Store the seed in many places with several (some perhaps
+    untrustworthy) people.
+
+  How can we address these conflicting requirements?

macOS.org

@@ -19,7 +19,7 @@
     'slip39		= slip39.main:main',
     'slip39-recovery	= slip39.recovery.main:main',
     'slip39-generator	= slip39.generator.main:main',
-    'slip39-App		= slip39.App.main:main',
+    'slip39-gui		= slip39.gui.main:main',
 ]
 
 entry_points			= {
@@ -33,15 +33,15 @@
     for option in [
         'serial',	# slip39[serial]: Support serial I/O of generated wallet data
         'json',		# slip39[json]:   Support output of encrypted Ethereum JSON wallets
-        'gui',		# slip39[gui]:    Support PySimpleGUI/tkinter graphical UI App
+        'gui',		# slip39[gui]:    Support PySimpleGUI/tkinter Graphical UI App
     ]
 }
 
 package_dir			= {
     "slip39":			"./slip39",
     "slip39.recovery":		"./slip39/recovery",
     "slip39.generator":		"./slip39/generator",
-    "slip39.App":		"./slip39/App",
+    "slip39.gui":		"./slip39/gui",
 }
 
 long_description_content_type	= 'text/markdown'
@@ -169,7 +169,8 @@
     "Bug Tracker": "https://github.com/pjkundert/python-slip39/issues",
 }
 
-# For py2{app,exe} App Generation
+'''
+# For py2{app,exe} App Generation.  TODO: Does not work; use PyInstaller instead
 mainscript			= "SLIP39.py"
 
 if sys.platform == 'darwin':
@@ -200,6 +201,7 @@
         # and install the main script as such
         scripts		= [ mainscript ],
     )
+'''
 
 setup(
     name			= "slip39",
@@ -222,5 +224,5 @@
     url				= "https://github.com/pjkundert/python-slip39",
     classifiers			= classifiers,
     python_requires		= ">=3.9",
-    **extra_options
+    #**extra_options
 )