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

TPI: FastAPI tutorial [part 3] #22301

Closed
2 tasks done
luabud opened this issue Oct 24, 2023 · 2 comments
Closed
2 tasks done

TPI: FastAPI tutorial [part 3] #22301

luabud opened this issue Oct 24, 2023 · 2 comments

Comments

@luabud
Copy link
Member

luabud commented Oct 24, 2023

Refs: #21586

Complexity: 5

Create Issue


We are adding a FastAPI tutorial to our Python docs page (PR). Because it's a fairly large doc to go through, I've broken it down into smaller pieces for the TPIs. You should be able to run through the section defined in this issue without having to read any previous content from the doc, even though a bit of the context might be missing.

Set up:

  1. Create a GitHuib Codespace on the main branch of this code sample: https://github.com/microsoft/python-sample-vscode-fastapi-tutorial
  2. Replace the content in the main,py file with the following:
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}
  1. Set the following settings in the workspace settings.json:
{
    "python.analysis.typeCheckingMode": "basic",
    "python.analysis.inlayHints.functionReturnTypes": true,
    "python.analysis.inlayHints.variableTypes": true
}

Steps:

  1. Follow the "Create Routes" section in the tutorial-fastapi.md file in this PR: Add FastAPI tutorial to Python docs  vscode-docs#6760

Things we're looking for in this TPI:

  • Ensure the guidance makes sense and is accurate
  • Ensure you get to a successful state at each step
  • Any feedback on wording/structure of this section in the tutorial

You can feel free to open issues with problems you find, or comment in the PR directly.

@ghost ghost assigned lszomoru and Tyriar Oct 24, 2023
@lszomoru
Copy link
Member

The tutorial is easier to follow here than in the PR.

@lszomoru
Copy link
Member

Ran though the steps in Codespaces, and everything worked as expected 👏

@lszomoru lszomoru removed their assignment Oct 24, 2023
@karthiknadig karthiknadig added this to the October 2023 milestone Oct 24, 2023
@Tyriar Tyriar removed their assignment Oct 24, 2023
@Tyriar Tyriar closed this as completed Oct 24, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants