Port the README changes and test suite from the dev branch.

Author: freakboy3742

.github/workflows/release.yaml

@@ -39,7 +39,9 @@ jobs:
 
           Includes:
           * Python ${{ env.PY_VERSION }}.?
-          * ...
+          * OpenSSL 1.1.1?
+          * BZip2 1.0.8
+          * XZ 5.2.5
     outputs:
       upload_url: ${{ steps.create_release.outputs.upload_url }}
 

README.rst

@@ -1,7 +1,7 @@
 Python Apple Support
 ====================
 
-**This repository branch builds a packaged version of Python 3.7.11**.
+**This repository branch builds a packaged version of Python 3.7.13**.
 Other Python versions are available by cloning other branches of the main
 repository.
 
@@ -12,21 +12,39 @@ It works by downloading, patching, and building a fat binary of Python and
 selected pre-requisites, and packaging them as static libraries that can be
 incorporated into an XCode project.
 
-The binaries support x86_64 for macOS; arm64 for iOS and appleTV devices;
-and armv7k for watchOS. This should enable the code to run on:
-
-* MacBook (MacBooks using Apple Silicon will run under Rosetta x86 emulation)
-* iMac (iMacs using Apple Silicon will run under Rosetta x86 emulation)
-* Mac Mini (iMacs using Apple Silicon will run under Rosetta x86 emulation)
-* Mac Pro
-* iPhone (5s or later)
-* iPad (5th gen or later)
-* iPad Air (all models)
-* iPad Mini (2 or later)
-* iPad Pro (all models)
-* iPod Touch (6th gen or later)
-* Apple TV (4th gen or later)
-* Apple Watch
+It exposed *almost* all the modules in the Python standard library except for:
+    * dbm.gnu
+    * tkinter
+    * readline
+    * nis (Deprecated by PEP594)
+    * ossaudiodev (Deprecated by PEP594)
+    * spwd (Deprecated by PEP594)
+
+The following standard library modules are available on macOS, but not the other
+Apple platforms:
+    * curses
+    * posixshmem
+    * posixsubprocess
+
+The binaries support x86_64 for macOS; arm64 for iOS and appleTV devices; and
+armv7k for watchOS. It also supports device simulators on both x86_64 and M1
+hardware. This should enable the code to run on:
+
+* macOS 10.8 (Catalina) or later, on:
+    * MacBook (MacBooks using Apple Silicon will run under Rosetta emulation)
+    * iMac (iMacs using Apple Silicon will run under Rosetta emulation)
+    * Mac Mini (Mac Minis using Apple Silicon will run under Rosetta emulation)
+    * Mac Studio (using Rosetta emulation)
+    * Mac Pro (all models)
+* iOS 8.0 or later, on:
+    * iPhone (6s or later)
+    * iPad (5th gen or later)
+    * iPad Air (all models)
+    * iPad Mini (2 or later)
+    * iPad Pro (all models)
+    * iPod Touch (7th gen or later)
+* tvOS 9.0 or later, on Apple TV (4th gen or later)
+* watchOS 4.0 or later, on Apple Watch (1st-3rd gen)
 
 Quickstart
 ----------
@@ -47,7 +65,7 @@ This should:
 
 1. Download the original source packages
 2. Patch them as required for compatibility with the selected OS
-3. Build the packages as XCode-compatible frameworks.
+3. Build the packages in an XCode-compatible form.
 
 The build products will be in the `build` directory; the compiled frameworks
 will be in the `dist` directory.

tests/testbed/README.rst

@@ -0,0 +1,13 @@
+Python Apple Support Testbed
+============================
+
+This is a testbed application that can be used to do basic verification checks
+of the Python Apple Support builds.
+
+The app can be deployed with Briefcase. When executed, (using `briefcase run
+macOS Xcode` or `briefcase run iOS`) the app will generate output on the console
+log that is similar to a unit test suite. If it returns 0 test failures, you can
+have some confidence that the support build is functioning as expected.
+
+The default configuration assumes that you have already run `make` in the root
+directory of this repository.

tests/testbed/pyproject.toml

@@ -0,0 +1,40 @@
+[tool.briefcase]
+project_name = "Testbed"
+bundle = "org.beeware"
+version = "0.0.1"
+url = "https://beeware.org"
+license = "BSD license"
+author = 'Russell Keith-Magee'
+author_email = "[email protected]"
+
+[tool.briefcase.app.testbed]
+formal_name = "Testbed"
+description = "A testbed for the Apple Support packages."
+icon = "src/testbed/resources/testbed"
+sources = ['src/testbed']
+requires = [
+]
+
+[tool.briefcase.app.testbed.macOS]
+requires = [
+    "rubicon-objc",
+    "std-nslog",
+]
+support_package = "../../dist/Python-3.7-macOS-support.custom.tar.gz"
+
+[tool.briefcase.app.testbed.linux]
+supported = false
+
+[tool.briefcase.app.testbed.windows]
+supported = false
+
+# Mobile deployments
+[tool.briefcase.app.testbed.iOS]
+requires = [
+    "rubicon-objc",
+    "std-nslog",
+]
+support_package = "../../dist/Python-3.7-iOS-support.custom.tar.gz"
+
+[tool.briefcase.app.testbed.android]
+supported = false

tests/testbed/src/testbed/__init__.py

@@ -0,0 +1,4 @@
+from testbed.app import main
+
+if __name__ == "__main__":
+    main()

tests/testbed/src/testbed/__main__.py

@@ -0,0 +1,60 @@
+"""
+A testbed for the Apple Support packages.
+"""
+import importlib
+import platform
+import sys
+import traceback
+
+from . import common
+
+
+def discover_tests(module):
+    "Discover all the test methods in the given module"
+    return [
+        (getattr(module, "__name__").split(".")[-1], getattr(module, name))
+        for name in dir(module)
+        if name.startswith("test_")
+    ]
+
+
+def main():
+    # This should start and launch your app!
+    print("=" * 80)
+    print(f"Python {platform.python_version()} Apple Support verification suite")
+    print(f"Running on {platform.platform()}")
+    print("=" * 80)
+    # Discover the common test suite
+    suite = discover_tests(common)
+
+    # Discover the platform-specific tests
+    try:
+        module = importlib.import_module(f".{sys.platform}", "testbed")
+        suite.extend(discover_tests(module))
+    except ModuleNotFoundError:
+        print(f"No platform-specific tests for {sys.platform}")
+
+    # Run the suite
+    failures = 0
+    tests = 0
+    for sys_platform, test in suite:
+        try:
+            tests += 1
+            # If the test has a docstring, use that text;
+            # otherwise, use the test name
+            if test.__doc__:
+                print(f"{sys_platform}: {test.__doc__}", end="...")
+            else:
+                print(f"{sys_platform}: {test.__name__}", end="...")
+            test()
+            print(" ok")
+        except Exception:
+            failures += 1
+            print(" FAILED!")
+            print("-" * 80)
+            traceback.print_exc()
+            print("-" * 80)
+
+    print("=" * 80)
+    print(f"Tests complete; {tests} tests, {failures} failures.")
+    sys.exit(failures)