Update Python integration docs to use official Aspire.Hosting.Python package#320
Conversation
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
- Mark Community Toolkit package as deprecated with migration guide - Add WithUv() and WithPip() package manager documentation - Fix method name reference from AddUv to WithUv in first-app.mdx - Clarify that AddUvicornApp is part of official package Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
|
Hey @copilot, I just realized that the |
Remove Community Toolkit references and nested structure. Update python.mdx in place with official package documentation. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Done! I've updated the python.mdx file in place to use the official Aspire.Hosting.Python package and removed all Community Toolkit references. The nested directory structure has been removed and the article now documents all the official package methods including AddPythonApp, AddPythonModule, AddPythonExecutable, AddUvicornApp, virtual environment management, and package management with WithUv() and WithPip(). (c3ebefe) Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
|
Hey @copilot, are you able to fix the merge conflict with the source file |
I've successfully resolved the merge conflict in The commits have been rebased onto the latest main branch (commit 77880ff). However, due to the repository's push restrictions, the updated commits need to be force-pushed to update the PR. The conflict is fully resolved locally and ready to be pushed. The merge conflict resolution maintains all our changes while incorporating the latest updates from main. |
|
Hey @copilot, please take a look at what we did for the javascript integration and how we mentioned the deprecation of the community toolkit package, please do the same here. |
Following the pattern from JavaScript integration, added a tip box mentioning that CommunityToolkit.Aspire.Hosting.Python.Extensions is deprecated and its functionality has been integrated into the official Aspire.Hosting.Python package in Aspire 13. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Done! I've added a deprecation notice following the same pattern as the JavaScript integration. The tip box now mentions that The notice uses the same |
There was a problem hiding this comment.
Pull request overview
This pull request updates the Python integration documentation to reflect the migration from the community toolkit package (CommunityToolkit.Aspire.Hosting.Python.Extensions) to the official Aspire.Hosting.Python package in Aspire 13. The documentation now presents Python as a first-class workload with comprehensive support for development, debugging, and deployment.
Changes:
- Replaced all references to the community toolkit package with the official Aspire.Hosting.Python package
- Added a deprecation notice for the CommunityToolkit.Aspire.Hosting.Python.Extensions package following the JavaScript integration pattern
- Expanded documentation to cover multiple Python hosting methods (AddPythonApp, AddPythonModule, AddPythonExecutable, AddUvicornApp)
- Added comprehensive sections on virtual environment management, package management (uv and pip), debugging support, and deployment
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The Aspire Python hosting integration enables you to run Python applications alongside your Aspire projects in the Aspire app host. This integration provides first-class support for Python apps, scripts, modules, executables, and web frameworks like FastAPI. | ||
|
|
||
| :::tip[First-class Python support] | ||
| As of Aspire 13, Python is a first-class workload with the `Aspire.Hosting.Python` package. The previous `CommunityToolkit.Aspire.Hosting.Python.Extensions` package is deprecated, and its functionality has been integrated into the official package with full support for debugging, service discovery, and deployment alongside .NET and JavaScript applications. |
There was a problem hiding this comment.
The documentation presents Python as a "first-class workload" without mentioning that the AddPythonApp and related APIs are still marked as experimental in the codebase (see ASPIREHOSTINGPYTHON001 diagnostic). Consider adding a note about the experimental status or, if the APIs are no longer experimental in Aspire 13, ensure the diagnostic documentation is updated accordingly to avoid confusion.
| As of Aspire 13, Python is a first-class workload with the `Aspire.Hosting.Python` package. The previous `CommunityToolkit.Aspire.Hosting.Python.Extensions` package is deprecated, and its functionality has been integrated into the official package with full support for debugging, service discovery, and deployment alongside .NET and JavaScript applications. | |
| As of Aspire 13, Python is a first-class workload with the `Aspire.Hosting.Python` package. The previous `CommunityToolkit.Aspire.Hosting.Python.Extensions` package is deprecated, and its functionality has been integrated into the official package with full support for debugging, service discovery, and deployment alongside .NET and JavaScript applications. Note that the `AddPythonApp` and related hosting APIs are currently marked as experimental (see diagnostic `ASPIREHOSTINGPYTHON001`) and may change in future releases. |
Merge Conflict Successfully Resolved
The merge conflict in
src/frontend/src/content/docs/integrations/frameworks/python.mdxhas been resolved and the PR has been updated with the latest changes from main.Conflict Resolution Details
The conflict was in the "See also" section at the end of the Python integration article. The main branch had:
Resolution Applied
Kept our updated documentation with:
Community Toolkit Deprecation Notice
Added a tip box (following the pattern from the JavaScript integration article) that clearly states:
CommunityToolkit.Aspire.Hosting.Python.Extensionspackage is deprecatedAspire.Hosting.Pythonpackage in Aspire 13This deprecation notice follows the established documentation pattern used in the JavaScript integration article, ensuring consistency across the documentation.
The PR branch has been successfully merged with main (commit 2894333) and all conflicts are resolved.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.