Skip to content

Commit 3671947

Browse files
authored
Mark Aspire.Hosting.Python as experimental (#6340)
Fixes #6298
1 parent ef20bde commit 3671947

File tree

4 files changed

+18
-9
lines changed

4 files changed

+18
-9
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<Project>
2+
<PropertyGroup>
3+
<!-- This needs to be set to true before importing parent Directory.Build.props -->
4+
<!-- In preview until the public API is validated. -->
5+
<SuppressFinalPackageVersion>true</SuppressFinalPackageVersion>
6+
</PropertyGroup>
7+
8+
<Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />
9+
</Project>

src/Aspire.Hosting.Python/PythonAppResource.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Aspire.Hosting.Python;
99

1010
/// <summary>
11-
/// A resource that represents a python executible or app.
11+
/// A resource that represents a python executable or app.
1212
/// </summary>
1313
/// <param name="name">The name of the resource.</param>
1414
/// <param name="executablePath">The path to the executable used to run the python app.</param>
@@ -18,4 +18,4 @@ public class PythonAppResource(string name, string executablePath, string projec
1818
{
1919
private static string ThrowIfNull([NotNull] string? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null)
2020
=> argument ?? throw new ArgumentNullException(paramName);
21-
}
21+
}

src/Aspire.Hosting.Python/PythonAppResourceBuilderExtensions.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ public static class PythonAppResourceBuilderExtensions
4444
/// </para>
4545
/// </remarks>
4646
/// <example>
47-
/// Add a python app or executible to the application model. In this example the python code entry point is located in the <c>PythonProject</c> directory
48-
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual enviroment path if relative
47+
/// Add a python app or executable to the application model. In this example the python code entry point is located in the <c>PythonProject</c> directory
48+
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual environment path if relative
4949
/// is relative to the project directory. In the example below, if the app host directory is <c>$HOME/repos/MyApp/src/MyApp.AppHost</c> then
5050
/// the ProjectPath would be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject</c> and the virtual environment path (defaulted) would
5151
/// be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject/.venv</c>.
@@ -93,8 +93,8 @@ public static IResourceBuilder<PythonAppResource> AddPythonApp(
9393
/// </para>
9494
/// </remarks>
9595
/// <example>
96-
/// Add a python app or executible to the application model. In this example the python code is located in the <c>PythonProject</c> directory
97-
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual enviroment path if relative
96+
/// Add a python app or executable to the application model. In this example the python code is located in the <c>PythonProject</c> directory
97+
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual environment path if relative
9898
/// is relative to the project directory. In the example below, if the app host directory is <c>$HOME/repos/MyApp/src/MyApp.AppHost</c> then
9999
/// the ProjectPath would be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject</c> and the virtual environment path (defaulted) would
100100
/// be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject/.venv</c>.
@@ -177,4 +177,4 @@ private static void AddOpenTelemetryArguments(CommandLineArgsCallbackContext con
177177
context.Args.Add("--metrics_exporter");
178178
context.Args.Add("otlp");
179179
}
180-
}
180+
}

src/Aspire.Hosting.Python/PythonProjectResourceBuilderExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public static class PythonProjectResourceBuilderExtensions
4646
/// </remarks>
4747
/// <example>
4848
/// Add a python project to the application model. In this example the project is located in the <c>PythonProject</c> directory
49-
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual enviroment path if relative
49+
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual environment path if relative
5050
/// is relative to the project directory. In the example below, if the app host directory is <c>$HOME/repos/MyApp/src/MyApp.AppHost</c> then
5151
/// the ProjectPath would be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject</c> and the virtual environment path (defaulted) would
5252
/// be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject/.venv</c>.
@@ -96,7 +96,7 @@ public static IResourceBuilder<PythonProjectResource> AddPythonProject(
9696
/// </remarks>
9797
/// <example>
9898
/// Add a python project to the application model. In this example the project is located in the <c>PythonProject</c> directory
99-
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual enviroment path if relative
99+
/// if this path is relative then it is assumed to be relative to the AppHost directory, and the virtual environment path if relative
100100
/// is relative to the project directory. In the example below, if the app host directory is <c>$HOME/repos/MyApp/src/MyApp.AppHost</c> then
101101
/// the ProjectPath would be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject</c> and the virtual environment path (defaulted) would
102102
/// be <c>$HOME/repos/MyApp/src/MyApp.AppHost/PythonProject/.venv</c>.

0 commit comments

Comments
 (0)