Skip to content

docs(functions): Functions README lacks installation options and complete examples #1216

@juni2003

Description

@juni2003

Problem

The Functions-py README.md is incomplete and lacks essential information:

  1. Installation section only shows pip3 method, missing uv/poetry options
  2. Vague documentation reference—"as per documentation" without actual links
  3. Incomplete examples—missing error handling, authentication, and sync client
  4. Inconsistent with other packages—auth/README.md shows multiple installation methods

Proposed Solution

Improve the README by:

  • Adding installation options for pip, uv, and poetry (consistent with auth package)
  • Adding proper documentation links
  • Adding comprehensive sync/async examples with error handling
  • Adding authentication setup examples

Files to Update

  • src/functions/README.md

This improves developer experience and matches the documentation quality of other Supabase Python packages.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions