Skip to content

Commit 012598e

Browse files
committed
Improve install instructions
1 parent 3ca484b commit 012598e

File tree

4 files changed

+238
-185
lines changed

4 files changed

+238
-185
lines changed

README.org

Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2304,31 +2304,50 @@ f"MultiPayoutERC20 Contract & Forwarder Details:\n\n{mp}\n\n"
23042304

23052305
If you =git clone [email protected]:pjkundert/python-slip39.git= and have the source code, you can use
23062306
the supplied GNU =make= targets to create a venv Virtual Environment and build then install.
2307+
2308+
The GUI requires Python3 with =tk= support, and uses PySimpleGUI which has a 30-day trial period,
2309+
after which it requires a license.
2310+
2311+
** Homebrew on macOS, or Nix on Linux or macOS
2312+
2313+
The =python-slip39= project is tested under both homebrew:
2314+
: $ brew install [email protected]
2315+
: $ PY3=python3.12 make venv
2316+
: ...
2317+
: (python-slip39-13.0.0-usr-darwin-cpython-312) bash-3.2$
2318+
and using [[https://www.python.org/downloads/][the official python.org/downloads installer]].
2319+
2320+
It is also supported under Nix (optionally prefixed with eg. =TARGET\=py310=):
2321+
: $ make nix-venv
2322+
: ...
2323+
: *** Activating /Users/perry/src/python-slip39-13.0.0-nix-darwin-cpython-312 VirtualEnv for Interactive /bin/bash
2324+
: (python-slip39-13.0.0-nix-darwin-cpython-312) Perrys-MBP:python-slip39 perry$
2325+
The Nix installation is probably the recommended approach for macOS and Linux.
2326+
2327+
Either of these methods will get you a =python3= executable running version 3.12+, usable for
2328+
running the =slip39= module, and the =slip39.gui= GUI.
2329+
2330+
** Native Python3 on Linux
2331+
2332+
To manually create your own venv and install from pypi using the Python 3.9 to 3.12 (+ TK if using
2333+
the GUI) you have at hand:
2334+
2335+
1) Ensure your Python3 has =tk= and =pip=, and GNU =make=; on Linux systems, this might be something like:
2336+
: $ sudo apt install make python3-pip python3-tk
23072337

2308-
The =python-slip39= project is tested under both homebrew:
2309-
: $ brew install [email protected]
2310-
: $ PY3=python3.12 make venv
2311-
: ...
2312-
: (python-slip39-13.0.0-usr-darwin-cpython-312) bash-3.2$
2313-
and using [[https://www.python.org/downloads/][the official python.org/downloads installer]].
2314-
2315-
It is also supported under Nix (optionally prefixed with eg. =TARGET\=py310=):
2316-
: $ make nix-venv
2317-
: ...
2318-
: *** Activating /Users/perry/src/python-slip39-13.0.0-nix-darwin-cpython-312 VirtualEnv for Interactive /bin/bash
2319-
: (python-slip39-13.0.0-nix-darwin-cpython-312) Perrys-MBP:python-slip39 perry$
2320-
The Nix installation is probably the recommended approach for macOS and Linux.
2321-
2322-
Either of these methods will get you a =python3= executable running version 3.12+, usable for
2323-
running the =slip39= module, and the =slip39.gui= GUI.
2324-
2325-
To manually create your own venv and install from pypi using the Python 3.9 to 3.12 (+ TK if using
2326-
the GUI) you have at hand:
2327-
: $ python3.12 -m venv python-slip39-venv
2328-
: $ . ./python-slip39-venv/bin/activate
2329-
: (python-slip39-venv) [you@yourhost src]$ python3 -m pip install slip39[gui]
2330-
: ...
2331-
: (python-slip39-venv) [you@yourhost src]$ python3 -m slip39.gui
2338+
2) Create the Python3 Virtual Environment using the GNU =make= target =venv=; this will create the
2339+
venv, and install =slip39= in it:
2340+
: $ cd python-slip39
2341+
: $ make venv
2342+
: $ python3 -m slip39.gui
2343+
To create it manually, and then install =slip39=, go into the =python-slip39= directory you cloned, and:
2344+
: $ python3 -m venv python-slip39-venv
2345+
: $ . ./python-slip39-venv/bin/activate
2346+
: (python-slip39-venv) [you@yourhost src]$ python3 -m pip install slip39[gui]
2347+
: ...
2348+
: (python-slip39-venv) [you@yourhost src]$ python3 -m slip39.gui
2349+
3) The GUI is built using PySimpleGUI, which has a 30-day trial period before you have to purchase
2350+
a license. Accept the trial period, and the GUI will be displayed.
23322351

23332352
** The =slip39= Module
23342353

README.pdf

1.46 KB
Binary file not shown.

0 commit comments

Comments
 (0)