Problem
The Python package supports asynchronous usage with httpx, but the main
Python usage documentation primarily demonstrates synchronous usage with
requests.
Users looking to integrate SmoothAPI into an async application would
benefit from a simple copy-pasteable example.
What needs to be done
Add an asynchronous httpx.AsyncClient example to the Python README.
The example should demonstrate:
- Creating an async client
- Configuring SmoothAPI
- Making an asynchronous request
- Properly awaiting the request
Acceptance Criteria
Files to look at
packages/smooth-api-py/README.md
README.md
Prerequisites
Basic Python and basic async/await knowledge.
Notes
Keep the example concise and consistent with the existing documentation.
Problem
The Python package supports asynchronous usage with
httpx, but the mainPython usage documentation primarily demonstrates synchronous usage with
requests.Users looking to integrate SmoothAPI into an async application would
benefit from a simple copy-pasteable example.
What needs to be done
Add an asynchronous
httpx.AsyncClientexample to the Python README.The example should demonstrate:
Acceptance Criteria
httpx.AsyncClientexample is includedasync/awaitFiles to look at
packages/smooth-api-py/README.mdREADME.mdPrerequisites
Basic Python and basic async/await knowledge.
Notes
Keep the example concise and consistent with the existing documentation.