From f6d6a692e90e02d6d66f8f74c35a432c46b68792 Mon Sep 17 00:00:00 2001 From: Greg Price Date: Mon, 15 Jul 2019 18:57:58 -0700 Subject: [PATCH 1/2] docs: Update sample `pyoxidizer run` output in first example. This is what it looks like for me with the v0.2.0 release (modulo adjusting the project's root directory to follow the example.) Various other bits of output in examples have also changed. But it'd be a lot of work to update them all comprehensively, and I think better to update piecemeal than not at all. --- docs/getting_started.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index ad321d1b8..240f5cd59 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -112,9 +112,7 @@ test that:: processing config file /home/gps/src/pyapp/pyoxidizer.toml resolving Python distribution... ... - Compiling pyapp v0.1.0 (/home/gps/src/pyapp) - Finished dev [unoptimized + debuginfo] target(s) in 53.14s - Running `target/debug/testapp` + pyapp packaged into /home/gps/src/pyapp/build/apps/pyapp/debug >>> If all goes according to plan, you just started a Rust executable which From 3e78c139cb99daa95d5d115143a4488bb2d2aaa9 Mon Sep 17 00:00:00 2001 From: Greg Price Date: Mon, 15 Jul 2019 19:13:29 -0700 Subject: [PATCH 2/2] docs: Be explicit up front about getting the actual executable. Looking at the getting-started page of the docs, because everything is in terms of `pyoxidizer run` it's not obvious how to actually lay hands on the single executable file that PyOxidizer produces. Here's one example of a puzzled would-be user: https://groups.google.com/forum/#!topic/pyoxidizer-users/rUyM3iTpZq0 Fix that by breaking up the first example into `pyoxidizer build` and then an explicit invocation of the built executable. --- docs/getting_started.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 240f5cd59..c0c759302 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -104,20 +104,24 @@ But if you aren't, keep reading. The default project created by ``pyoxidizer init`` will produce an executable that embeds Python and starts a Python REPL by default. Let's -test that:: +build that executable, with ``pyoxidizer build``:: $ cd pyapp - $ pyoxidizer run + $ pyoxidizer build no existing PyOxidizer artifacts found processing config file /home/gps/src/pyapp/pyoxidizer.toml resolving Python distribution... ... pyapp packaged into /home/gps/src/pyapp/build/apps/pyapp/debug + executable path: /home/gps/src/pyapp/build/apps/pyapp/debug/pyapp + +Now just run the executable! The path is given at the end of the +``pyoxidizer build`` output:: + + $ /home/gps/src/pyapp/build/apps/pyapp/debug/pyapp >>> -If all goes according to plan, you just started a Rust executable which -started a Python interpreter, which started an interactive Python debugger! -Try typing in some Python code:: +Try some Python code into this REPL:: >>> print("hello, world") hello, world