docs: mention flask as the base framework

[grant]

Documents the base request framework used for this library.

Fixes #80
R @anniefu

[di]

I don't think this is sufficient to fix #80? That issue is about documenting the type of the request parameter. Linking to the Flask docs is a sort of roundabout way to do it, I'm not sure that would be clear to the average user that this means that the request parameter is a Flask Request object.

[grant]

I don't think this is sufficient to fix #80? That issue is about documenting the type of the request parameter. Linking to the Flask docs is a sort of roundabout way to do it, I'm not sure that would be clear to the average user that this means that the request parameter is a Flask Request object.

Do you have an idea of how we can fix this?

Should we link this instead?

https://flask.palletsprojects.com/en/1.1.x/api/#flask.request

[di]

In #80 I pointed out that we already do this at https://cloud.google.com/functions/docs/concepts/events-triggers#functions_parameters-python, which says:

Your function is passed a single parameter, (request), which is a Flask Request object.

We could copy/paste this into the docs here, or we could just link to https://cloud.google.com/functions/docs/concepts/events-triggers#functions_parameters-python which also documents this for background functions as well.

[grant]

In #80 I pointed out that we already do this at cloud.google.com/functions/docs/concepts/events-triggers#functions_parameters-python, which says:

Your function is passed a single parameter, (request), which is a Flask Request object.

We could copy/paste this into the docs here, or we could just link to cloud.google.com/functions/docs/concepts/events-triggers#functions_parameters-python which also documents this for background functions as well.

Yes, Cloud Functions does talk about this in more detail. However, the Function Frameworks are supposed to be runnable outside of Cloud Functions. I think it's not reasonable to expect users to go find that page, and it's reasonable to talk about the fact Flask is used, especially for new developers. Ruby, Node, other languages state info like this as well.

[anniefu]

For me, I'm happy as long as the Flask Request is documented. My two cents here is that we should copy/paste the Flask request bit into this repo.

At the end of the day, Functions Framework decides what the request format is, and the Google Cloud Docs get updated to match, so this repo should be the most up-to-date source of truth.

[grant]

@di Can you suggest an alternative way to mention Flask for the user's function handler in the README?

[di]

In #134 (comment) I said that we could copy/paste the following into the docs here from the Cloud Functions docs:

Your function is passed a single parameter, (request), which is a Flask Request object.

Is there any reason that we don't want to do that?

[grant]

In #134 (comment) I said that we could copy/paste the following into the docs here from the Cloud Functions docs:

Your function is passed a single parameter, (request), which is a Flask Request object.

Is there any reason that we don't want to do that?

That's fine. I think I've update the PR to fit your suggestion.

[di]

LGTM, not sure why conformance tests are now failing though.