Skip to content

Commit 16b9f69

Browse files
hallvictoriaVictoria Hall
and
Victoria Hall
authored
docs: missed fastapi renaming references (#40)
* missed renaming refs * readme title * readme fixes --------- Co-authored-by: Victoria Hall <[email protected]>
1 parent c6af254 commit 16b9f69

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

azurefunctions-extensions-http-fastapi/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
# Azure Functions Extension FastApi library for Python
1+
# Azure Functions Extensions Http FastApi library for Python
22
This library contains HttpV2 extensions for FastApi Request/Response types to use in your function app code.
33

44
[Source code](https://github.com/Azure/azure-functions-python-extensions/tree/main/azurefunctions-extensions-http-fastapi)
5-
| Package (PyPi)
6-
| Package (Conda)
5+
| [Package (PyPi)](https://pypi.org/project/azurefunctions-extensions-http-fastapi/)
76
| API reference documentation
87
| Product documentation
98
| [Samples](hhttps://github.com/Azure/azure-functions-python-extensions/tree/main/azurefunctions-extensions-http-fastapi/samples)
@@ -18,13 +17,13 @@ This library contains HttpV2 extensions for FastApi Request/Response types to us
1817
### Instructions
1918
1. Follow the guide to [create an app](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-cli-python?tabs=windows%2Cbash%2Cazure-cli%2Cbrowser).
2019
2. Ensure your app is using programming model v2 and contains a http trigger function.
21-
3. Add azurefunctions-extensions-http-fastapi to your requirement.txt
22-
4. Import Request and different types of responses from azure.functions.extensions.fastapi in your httptrigger functions.
23-
5. Change the request and response types to ones imported from azure.functions.extensions.fastapi.
20+
3. Add ```azurefunctions-extensions-http-fastapi``` to your requirements.txt
21+
4. Import Request and different types of responses from ```azurefunctions.extensions.http.fastapi``` in your HttpTrigger functions.
22+
5. Change the request and response types to ones imported from ```azurefunctions.extensions.http.fastapi```.
2423
6. Run your function app and try it out!
2524

2625
### Bind to the FastApi-type
27-
The Azure Functions Extension FastApi library for Python allows you to create a function app with FastApi Request or Response types. When your function runs, you will receive the request of FastApi Request type and you can return a FastApi response type instance. FastApi is one of top popular python web framework which provides elegant and powerful request/response types and functionalities to users. With this integration, you are empowered to use request/response the same way as using them in native FastApi. A good example is you can do http streaming upload and streaming download now! Feel free to check out [Fastapi doc] for further reference (https://fastapi.tiangolo.com/reference/responses/?h=custom)
26+
The Azure Functions Extensions Http FastApi library for Python allows you to create a function app with FastApi Request or Response types. When your function runs, you will receive the request of FastApi Request type and you can return a FastApi response type instance. FastApi is one of top popular python web framework which provides elegant and powerful request/response types and functionalities to users. With this integration, you are empowered to use request/response the same way as using them in native FastApi. A good example is you can do http streaming upload and streaming download now! Feel free to check out [Fastapi doc](https://fastapi.tiangolo.com/reference/responses/?h=custom) for further reference.
2827

2928

3029
```python

azurefunctions-extensions-http-fastapi/azurefunctions/extensions/http/fastapi/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@
2828
"FileResponse",
2929
]
3030

31-
__version__ = "1.0.0a1"
31+
__version__ = "1.0.0b1"

0 commit comments

Comments
 (0)