docs(functions): improve README with installation options and examples #1217
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add multiple installation methods (pip, uv, poetry) - Include comprehensive async and sync client examples - Add proper error handling and authentication examples - Link to official Supabase Functions documentation - Improve code structure and readability Fixes supabase#1216
grdsdev
approved these changes
Sep 16, 2025
Pull Request Test Coverage Report for Build 17558433745Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR significantly improves the Functions-py README documentation by addressing several usability issues and providing comprehensive examples.
Changes Made:
Fixes #1216
What kind of change does this PR introduce?
Documentation update
What is the current behavior?
The current README has minimal installation instructions (only pip3), lacks proper examples with error handling and authentication, and doesn't provide synchronous client examples. The documentation reference is vague without proper links.
What is the new behavior?
The updated README provides:
Additional context
This improvement makes the library much more accessible to new users by providing practical, copy-paste examples and comprehensive installation instructions.