Update cx_Freeze example.

Author: HexDecimal

examples/distribution/cx_Freeze/README.rst

@@ -1,11 +1,14 @@
 cx_Freeze Example
 =================
 
-First, install the packages: ``tdl`` and ``cx_Freeze``.
+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
 
-Then run the command::
+Once the virtual environment is active you should install `tcod` and `cx_Freeze` from the `requirements.txt` file, then build using `setup.py`:
 
-    python setup.py build_exe
+    pip install -r requirements.txt
+    python setup.py build
 
 An executable package will be placed in ``build/<platform>/``
 

examples/distribution/cx_Freeze/hello_world.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+import tcod
+
+WIDTH, HEIGHT = 80, 60
+console = None
+
+
+def main():
+    tileset = tcod.tileset.load_tilesheet(
+        "data/terminal8x8_gs_ro.png", 16, 16, tcod.tileset.CHARMAP_CP437
+    )
+    with tcod.context.new(
+        columns=WIDTH, rows=HEIGHT, tileset=tileset
+    ) as context:
+        while True:
+            console = tcod.console.Console(WIDTH, HEIGHT)
+            console.print(0, 0, "Hello World")
+            context.present(console)
+            for event in tcod.event.wait():
+                if isinstance(event, tcod.event.Quit):
+                    raise SystemExit()
+
+
+if __name__ == "__main__":
+    main()

examples/distribution/cx_Freeze/main.py

@@ -0,0 +1,2 @@
+tcod==12.0.0
+cx-freeze==6.5.3

examples/distribution/cx_Freeze/requirements.txt

@@ -1,22 +1,53 @@
-
+#!/usr/bin/env python3
 import sys
 
 from cx_Freeze import Executable, setup
 
-# cx_Freeze options, see documentation.
+# cx_Freeze options, see documentation:
+# https://cx-freeze.readthedocs.io/en/latest/distutils.html#build-exe
 build_exe_options = {
-    'packages': ['cffi'],
-    'excludes': [],
-    'include_files': ['data'],
-    }
+    "packages": [],
+    "excludes": [
+        "numpy.core.tests",
+        "numpy.distutils",
+        "numpy.doc",
+        "numpy.f2py.tests",
+        "numpy.lib.tests",
+        "numpy.ma.tests",
+        "numpy.ma.testutils",
+        "numpy.matrixlib.tests",
+        "numpy.polynomial.tests",
+        "numpy.random.tests",
+        "numpy.testing",
+        "numpy.tests",
+        "numpy.typing.tests",
+        "distutils",
+        "setuptools",
+        "msilib",
+        "test",
+        "tkinter",
+        "unittest",
+    ],
+    "include_files": ["data"],  # Bundle the data directory.
+    "optimize": 1,  # Enable release mode.
+    "include_msvcr": False,
+}
 
 # Hide the terminal on Windows apps.
 base = None
 if sys.platform == "win32":
     base = "Win32GUI"
 
 setup(
-    name='tdl cxfreeze example',
-    options = {'build_exe': build_exe_options},
-    executables = [Executable('hello_world.py', base=base)],
-    )
+    name="tcod cx_Freeze example",
+    options={"build_exe": build_exe_options},
+    executables=[
+        # cx_Freeze Executable options:
+        # https://cx-freeze.readthedocs.io/en/latest/distutils.html#cx-freeze-executable
+        Executable(
+            script="main.py",
+            base=base,
+            target_name="start",  # Name of the target executable.
+        )
+    ],
+)