Update PyInstaller example.

Author: HexDecimal

examples/distribution/PyInstaller/README.rst

@@ -1,19 +1,26 @@
 PyInstaller Example
 ===================
 
-First, install the packages: ``tcod`` and ``PyInstaller``.
+It's recommended to use a virtual environment to package Python executables.
+Use the following guide on how to set one up:
+https://docs.python.org/3/tutorial/venv.html
 
-On Windows you must also install the ``pywin32`` package
-(named ``pypiwin32`` if you're using pip install.)
+Once the virtual environment is active you should install ``tcod``, ``PyInstaller``, and ``pypiwin32`` if on Windows from the ``requirements.txt`` file:
 
-Then run the PyInstaller script with this command::
+    pip install -r requirements.txt
 
-    PyInstaller hello_world.py --add-data "terminal8x8_gs_ro.png;."
+Then run PyInstaller on the included Spec file::
+
+    PyInstaller main.spec
 
 The finished build will be placed in the ``dist/`` directory.
 
-You can also build to one executable file using the following command::
+You can also build to one file using the following command::
+
+    PyInstaller main.spec --onefile
+
+Single file distributions have performance downsides so it is preferred to distribute a larger program this way.
 
-    PyInstaller hello_world.py --add-data "terminal8x8_gs_ro.png;." --onefile
+For `tcod` it is recommended to set the ``PYTHONOPTIMIZE=1`` environment variable before running PyInstaller.  This disables warnings for `tcod`'s deprecated functions and will improve the performance of those functions if you were using them.
 
-The PyInstaller manual can be found at: https://pythonhosted.org/PyInstaller/
+The PyInstaller documentation can be found at: https://pythonhosted.org/PyInstaller/

…bution/PyInstaller/terminal8x8_gs_ro.png …n/PyInstaller/data/terminal8x8_gs_ro.pngexamples/distribution/PyInstaller/terminal8x8_gs_ro.png renamed to examples/distribution/PyInstaller/data/terminal8x8_gs_ro.png examples/distribution/PyInstaller/terminal8x8_gs_ro.png renamed to examples/distribution/PyInstaller/data/terminal8x8_gs_ro.png

@@ -13,21 +13,22 @@
 # The base directory, this is sys._MEIPASS when in one-file mode.
 BASE_DIR = getattr(sys, "_MEIPASS", ".")
 
-FONT_PATH = os.path.join(BASE_DIR, "terminal8x8_gs_ro.png")
+FONT_PATH = os.path.join(BASE_DIR, "data/terminal8x8_gs_ro.png")
 
 
 def main():
-    tcod.console_set_custom_font(FONT_PATH, tcod.FONT_LAYOUT_CP437)
-    with tcod.console_init_root(
-        WIDTH, HEIGHT, renderer=tcod.RENDERER_SDL2, vsync=True
-    ) as console:
+    tileset = tcod.tileset.load_tilesheet(
+        FONT_PATH, 16, 16, tcod.tileset.CHARMAP_CP437
+    )
+    with tcod.context.new(
+        columns=WIDTH, rows=HEIGHT, tileset=tileset
+    ) as context:
         while True:
-            console.clear()
+            console = tcod.console.Console(WIDTH, HEIGHT)
             console.print(0, 0, "Hello World")
-            tcod.console_flush()
-
+            context.present(console)
             for event in tcod.event.wait():
-                if event.type == "QUIT":
+                if isinstance(event, tcod.event.Quit):
                     raise SystemExit()
 
 

examples/distribution/PyInstaller/icon.ico

@@ -0,0 +1,42 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+block_cipher = None
+
+
+a = Analysis(
+    ["main.py"],
+    binaries=[],
+    datas=[("data", "data")],  # Include all files in the 'data' directory.
+    hiddenimports=[],
+    hookspath=[],
+    runtime_hooks=[],
+    excludes=[],
+    win_no_prefer_redirects=False,
+    win_private_assemblies=False,
+    cipher=block_cipher,
+    noarchive=False,
+)
+pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
+exe = EXE(
+    pyz,
+    a.scripts,
+    [],
+    exclude_binaries=True,
+    name="start",  # Name of the executable.
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    console=True,  # Set to False to disable the Windows terminal.
+    icon="icon.ico",  # Windows icon file.
+)
+coll = COLLECT(
+    exe,
+    a.binaries,
+    a.zipfiles,
+    a.datas,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    name="hello_world",  # Name of the distribution directory.
+)

…/distribution/PyInstaller/hello_world.py examples/distribution/PyInstaller/main.pyexamples/distribution/PyInstaller/hello_world.py renamed to examples/distribution/PyInstaller/main.py examples/distribution/PyInstaller/hello_world.py renamed to examples/distribution/PyInstaller/main.py

@@ -0,0 +1,3 @@
+tcod==12.2.0
+pyinstaller==4.2
+pypiwin32; sys_platform=="win32"