Merge branch 'main' into 3.6

Author: slozier

.gitattributes

@@ -45,5 +45,8 @@ tests/suite/file_without_BOM.txt -text
 # Do not normalize on commit.
 *.pdf -text
 
-*.pck linguist-detectable=false
-*.html linguist-documentation=true
+# Hide certain languages from GitHub Linguist
+* linguist-detectable=false
+*.cs linguist-detectable
+*.py linguist-detectable
+src/core/IronPython.StdLib/lib/** linguist-vendored

.github/workflows/main.yml

@@ -4,21 +4,23 @@ on: [push, pull_request]
 
 jobs:
   build:
-
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-latest, ubuntu-22.04, macos-latest-large]
+        os: [windows-latest, ubuntu-22.04, macos-latest]
 
     steps:
+      # Prerequisites
     - name: Install tools
       if: matrix.os == 'ubuntu-22.04'
       run: sudo apt-get -yq install mono-vbnc dos2unix
     - uses: actions/checkout@v4
       with:
         submodules: true
+
+      # Setup .NET
     - name: Setup .NET 6.0
       uses: actions/setup-dotnet@v4
       with:
@@ -31,26 +33,59 @@ jobs:
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: '9.0.x'
+
+      # CI debug information
     - name: Version Information
       run: |
         dotnet --info
         try { msbuild -version } catch { }
         try { mono --version } catch { }
       shell: pwsh
+
+      # Build & package
     - name: Build
       run: pwsh make.ps1
     - name: Package
       run: pwsh make.ps1 package
+
+      # Upload package
     - uses: actions/upload-artifact@v4
       with:
         name: packages-${{ matrix.os }}
         path: Package/Release/Packages
-    - name: Test (net462)
-      run: ./make.ps1 -frameworks net462 test-all
-      shell: pwsh
-    - name: Test (net6.0)
-      run: ./make.ps1 -frameworks net6.0 test-all
-      shell: pwsh
-    - name: Test (net8.0)
-      run: ./make.ps1 -frameworks net8.0 test-all
+
+  test:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-22.04, macos-latest]
+        framework: ['net462', 'net6.0', 'net8.0']
+
+    steps:
+      # Prerequisites
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+
+      # Setup .NET
+    - name: Setup .NET 6.0
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '6.0.x'
+    - name: Setup .NET 8.0
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '8.0.x'
+    - name: Setup .NET 9.0
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '9.0.x'
+
+      # Build & Test
+    - name: Build
+      run: pwsh make.ps1
+    - name: Test (${{ matrix.framework }})
+      run: ./make.ps1 -frameworks ${{ matrix.framework }} test-all
       shell: pwsh

.vsts-ci.yml

@@ -18,7 +18,7 @@ jobs:
   displayName: Linux (Ubuntu)
   timeoutInMinutes: 180
   pool:
-    vmImage: ubuntu-latest
+    vmImage: ubuntu-22.04
   steps:
   - template: eng/steps.yml
     parameters:

CONTRIBUTING.md

@@ -2,13 +2,13 @@
 
 The steps to contribute a change are:
 
-1. Fork the IronPython3 repository. For more information see [Getting the Sources](docs/getting-the-sources.md).
-2. Build the repository. For more information see [Building](docs/building.md).
-1. Make your changes on your machine, ensure ```make.ps1 test-all``` runs successfully, and commit your changes. For more information see [Modifying the Sources](docs/modifying-the-sources.md).
-1. Push the commits to your fork. This way your name will be the author of the commit in the main IronPython3 tree (once the commits are pulled into the main tree).
-1. Create a pull request on Github, this will initiate a code review and CLA signing request
-1. The IronPython team will review, and possibly request changes, to your PR
-1. Once all comments/questions/concerns have been addressed, your PR will be merged.
+1. Fork the IronPython3 repository. For more information see [Getting the Sources](https://github.com/IronLanguages/ironpython3/wiki/Getting-the-sources).
+2. Build the repository. For more information see [Building](https://github.com/IronLanguages/ironpython3/wiki/Building).
+3. Make your changes on your machine, ensure ```make.ps1 test-all``` runs successfully, and commit your changes. For more information see [Modifying the Sources](https://github.com/IronLanguages/ironpython3/wiki/Modifying-the-sources).
+4. Push the commits to your fork. This way your name will be the author of the commit in the main IronPython3 tree (once the commits are pulled into the main tree).
+5. Create a pull request on Github, this will initiate a code review and CLA signing request
+6. The IronPython team will review, and possibly request changes, to your PR
+7. Once all comments/questions/concerns have been addressed, your PR will be merged.
 
 Also, [Collaborative Github Workflow](http://www.eqqon.com/index.php/Collaborative_Github_Workflow) has a very good description of the workflow and tips and tricks when contributing to a project hosted on GitHub.
 

README.md

@@ -12,12 +12,14 @@ IronPython 3 targets Python 3, including the re-organized standard library, Unic
 | **What?** | **Where?** |
 | --------: | :------------: |
 | **Windows/Linux/macOS Builds** | [![Build status](https://dotnet.visualstudio.com/IronLanguages/_apis/build/status/ironpython3)](https://dotnet.visualstudio.com/IronLanguages/_build/latest?definitionId=43) [![Github build status](https://github.com/IronLanguages/ironpython3/workflows/CI/badge.svg)](https://github.com/IronLanguages/ironpython3/actions?workflow=CI) |
-| **Downloads** | [![NuGet](https://img.shields.io/nuget/vpre/IronPython.svg)](https://www.nuget.org/packages/IronPython/3.4.0) [![Release](https://img.shields.io/github/release/IronLanguages/ironpython3.svg?include_prereleases)](https://github.com/IronLanguages/ironpython3/releases/latest)|
+| **Downloads** | [![NuGet](https://img.shields.io/nuget/vpre/IronPython.svg)](https://www.nuget.org/packages/IronPython/latest) [![Release](https://img.shields.io/github/release/IronLanguages/ironpython3.svg?include_prereleases)](https://github.com/IronLanguages/ironpython3/releases/latest)|
 | **Help** | [![Gitter chat](https://badges.gitter.im/IronLanguages/ironpython.svg)](https://gitter.im/IronLanguages/ironpython) [![StackExchange](https://img.shields.io/badge/stack%20overflow-ironpython-informational?logo=stack-overflow&logoColor=white)](https://stackoverflow.com/questions/tagged/ironpython) |
 
 
 ## Examples
 
+To see how to use in PowerShell (either directly embedded or executable invocation), skip to [Installation](#Installation)
+
 The following C# program:
 
 ```cs
@@ -51,10 +53,12 @@ System.Console.WriteLine(greetings("world"));
 This example assumes that `IronPython` has been added to the C# project as a NuGet package.
 
 ## Code of Conduct
+
 This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
 For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
 
 ## State of the Project
+
 The current target is Python 3.4, although features and behaviors from later versions may be included.
 
 See the following lists for features from each version of CPython that have been implemented:
@@ -68,22 +72,84 @@ See the following lists for features from each version of CPython that have been
 - [What's New In Python 3.6](WhatsNewInPython36.md)
 
 ## Contributing
+
 For details on contributing see the [Contributing](CONTRIBUTING.md) article.
 
 ## Upgrading from IronPython 2
-For details on upgrading from IronPython 2 to 3 see the [Upgrading from IronPython 2 to 3](docs/upgrading-from-ipy2.md) article.
+
+For details on upgrading from IronPython 2 to 3 see the [Upgrading from IronPython 2 to 3](https://github.com/IronLanguages/ironpython3/wiki/Upgrading-from-IronPython2) article.
 
 ## Differences with CPython
-While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](docs/differences-from-c-python.md) for details.
+
+While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/wiki/Differences-from-CPython) for details.
 
 ## Package compatibility
-See the [Package compatibility](docs/package-compatibility.md) document for information on compatibility with popular packages.
+
+See the [Package compatibility](https://github.com/IronLanguages/ironpython3/wiki/Package-compatibility) document for information on compatibility with popular packages.
 
 ## Installation
-Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython/3.4.0). See the [installation document](docs/installing.md) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.
+
+Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython/latest). See the [installation document](https://github.com/IronLanguages/ironpython3/wiki/Installing) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.
+
+### PowerShell
+
+For usage in PowerShell, you can install using the Install-IronPython.ps1 within the aforementioned `.zip` file or by simply using this one-liner:
+
+```pwsh
+& ([scriptblock]::Create((iwr `
+    -Uri 'https://raw.githubusercontent.com/IronLanguages/ironpython3/main/eng/scripts/Install-IronPython.ps1').Content)) `
+    -Path "~/ipyenv/v3.4.2"
+
+# Optionally, ensure pip:
+# & "~/ipyenv/v3.4.2/ipy" -m ensurepip
+```
+
+Once installed, you can start using IronPython directly in PowerShell!
+
+To use the ipy shim, you can use:
+```pwsh
+& "~/ipyenv/v3.4.2/Enter-IronPythonEnvironment.ps1"
+
+ipy -c "print('Hello from IronPython!')"
+```
+
+... or to use IronPython embedded in PowerShell, you can use:
+```pwsh
+Import-Module "~/ipyenv/v3.4.2/IronPython.dll"
+
+$engine = & {
+    $engine = [IronPython.Hosting.Python]::CreateEngine()
+
+    # You need to add the correct paths, as IronPython will use PowerShell's installation path by default
+    $paths = $engine.GetSearchPaths()
+    $paths.Add("$(Resolve-Path "~/ipyenv/v3.4.2/lib")")
+    $paths.Add("$(Resolve-Path "~/ipyenv/v3.4.2/lib/site-packages")")
+
+    # To use `wpf` and `sqlite3` you have to add the DLLs search path
+    # - the [IronPython.SQLite] and [IronPython.WPF] powershell namespaces will become available on python import
+    $paths.Add("$(Resolve-Path "~/ipyenv/v3.4.2/DLLs")")
+
+    # or if you prefer to have the powershell namespaces early, you can use:
+    # - just note, you will have to initialize _sqlite3 (see further down the script)
+    # Import-Module "~/ipyenv/v3.4.2/DLLs/IronPython.SQLite.dll"
+    # Import-Module "~/ipyenv/v3.4.2/DLLs/IronPython.WPF.dll"
+
+    $engine.SetSearchPaths($paths)
+
+    # Then have fun!
+    $engine.Execute("print('Hello from IronPython!')")
+
+    # Optionally, if you need to initialize _sqlite3:
+    # $engine.Execute("import sqlite3")
+
+    return $engine
+}
+```
 
 ## Build
-See the [building document](docs/building.md). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!
+
+See the [building document](https://github.com/IronLanguages/ironpython3/wiki/Building). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!
 
 ## Supported Platforms
+
 IronPython 3 targets .NET Framework 4.6.2, .NET Standard 2.0, .NET 6.0 and .NET 8.0. The support for .NET and .NET Core follow the lifecycle defined on [.NET and .NET Core Support Policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core).

docs/building.md

@@ -1,50 +1 @@
-# Building IronPython3
-
-To build IronPython3 you will need the [.NET SDK (minimum v6.0.100)](https://dotnet.microsoft.com/download/visual-studio-sdks).
-
-See [Getting the Sources](getting-the-sources.md) for information on getting the source for IronPython3.
-
-## Building from Visual Studio
-
-Visual Studio 2022 v17.0 or above is required to build IronPython3.
-
- * Open the `IronPython.sln` solution file
- * Select the configuration options (Release, Debug, etc.)
- * Press Ctrl+Shift+B or F6 to build the solution
-
-## Building from the command line
-
-IronPython3 uses PowerShell to run the build and testing from the command line. You can either use a PowerShell directly, or prefix the commands below with `powershell` on Windows, or `pwsh` on Linux/macOS.
-
-On Linux/macOS you will need to install [PowerShell](https://github.com/PowerShell/PowerShell/releases)
-
-Change the working directory to the path where you cloned the sources and run `./make.ps1`
-
-By default, with no options, `make.ps1` will build the `Release` mode binaries. If you would like to build `Debug` binaries, you can run `./make.ps1 debug`
-
-Other options available for `make.ps1` are
-
-```
--configuration (debug/release)   The configuration to build for
--platform (x86/x64)              The platform to use in running tests
--runIgnored                      Run tests that are marked as ignored in the .ini manifests
--frameworks                      A comma separated list of frameworks to run tests for
-                                 (use nomenclature as is used in msbuild files for TargetFrameworks)
-```
-
-There are also other targets available for use with packaging and testing, most come in debug and release (default) versions, such as `package-debug` and `package`
-
-```
-package                         Creates packages supported by the current platform
-stage                           Stages files ready for packaging
-test-*                          Runs tests from `all` categories, `ironpython` specific tests,
-                                `cpython` tests from the CPython stdlib test suite
-```
-
-If the build is successful the binaries are stored in `ironpython3/bin/{Configuration}/{TargetFramework}`.
-
-## Running
-
-The standard library is not copied over to the `bin` folder during the build process, it lives in `src/core/IronPython.StdLib/lib`.
-- When running the `Release` configuration executable, you should set the environment variable `IRONPYTHONPATH` to this folder.
-- When running the `Debug` configuration executable, this folder is automatically added to `sys.path`.
+This document has been moved to the IronPython wiki: [Building](https://github.com/IronLanguages/ironpython3/wiki/Building)