Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a FastAPI tutorial to our docs #21586

Closed
luabud opened this issue Jul 8, 2023 · 5 comments
Closed

Add a FastAPI tutorial to our docs #21586

luabud opened this issue Jul 8, 2023 · 5 comments
Assignees
Labels
area-editor-* User-facing catch-all documentation on-testplan Added to test plan
Milestone

Comments

@luabud
Copy link
Member

luabud commented Jul 8, 2023

Given we already have a Django and a Flask tutorial, it'd be nice to create a FastAPI one.

@github-actions github-actions bot added the triage-needed Needs assignment to the proper sub-team label Jul 8, 2023
@luabud luabud added needs proposal Need to make some design decisions area-editor-* User-facing catch-all documentation and removed triage-needed Needs assignment to the proper sub-team labels Jul 8, 2023
@luabud
Copy link
Member Author

luabud commented Jul 17, 2023

Outline proposal:

Prerequisites

  • Set up the project:
    • GitHub Codespaces:
      • Link to template repo
    • VS Code:
      • Create and open folder
      • Set up a virtual environment with the create environment command.
      • Create main.py application.

Run and Debug the Project

  • Using Pydantic to define received payloads.
  • Using the automatic interactive docs at /docs to interact with the API.
  • Using Pylance’s Inlay hints.
  • Configuring the debugger.
  • Adding breakpoints.
  • Inspecting variables.
  • Running code in the debug console.

Set up and Run Tests

  • Creating tests.
  • Setting up the test explorer.
  • Running tests from the test explorer.

Next Steps

Links to:

  • Devcontainers
  • Deploying to Azure

@minsa110
Copy link

Thanks for getting started on the outline!

For pre-requisites, would it still make sense for us to have two paths where the other one would be to use Codespaces using a template repo (to be refined and hosted under Microsoft account)? We can link to the devcontainer from there too, since the template repo will be based on devcontainers.

In terms of the tutorials project, are we still thinking of ChatGPT plugin--maybe towards the end? If so, we should probably add debugging tutorial for that in Codespaces as well.

@cwebster-99
Copy link
Member

For pre-requisites, would it still make sense for us to have two paths where the other one would be to use Codespaces using a template repo (to be refined and hosted under Microsoft account)?

+1 I would love it if we could include this, whether it is the default set-up or a path like you phrased it.

@luabud
Copy link
Member Author

luabud commented Jul 20, 2023

love the idea! adjusted the outline to include that, thank you 😊

about this:

In terms of the tutorials project, are we still thinking of ChatGPT plugin--maybe towards the end? If so, we should probably add debugging tutorial for that in Codespaces as well.

I was assuming only the setup experience would be different across Codespaces and locally, so the rest of the tutorial would be the same for both setups, including debugging. Am I missing something? 🤔

@luabud
Copy link
Member Author

luabud commented Oct 27, 2023

Done! microsoft/vscode-docs#6760

@luabud luabud closed this as completed Oct 27, 2023
@luabud luabud added this to the October 2023 milestone Oct 27, 2023
@github-actions github-actions bot removed the needs proposal Need to make some design decisions label Oct 27, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-editor-* User-facing catch-all documentation on-testplan Added to test plan
Projects
None yet
Development

No branches or pull requests

3 participants