chore: deprecation changes

Author: o-santi

README.md

@@ -1,22 +1,16 @@
-# Functions-py
+# ⚠️⚠️⚠️ Deprecation notice ⚠️⚠️⚠️ 
 
+The `supafunc` package name is deprecated and is not going to receive any more updates. Please, use `supabase_functions` instead.
 
-## Installation
+## How to switch
 
-`pip3 install supafunc`
+1. Use `uv add supabase_functions` instead of `uv add supafunc`.
+2. Replace `supafunc` with `supabase_functions` in your `requirements.txt`, `pyproject.toml`, `setup.py`, etc.
+3. Replace all imports `from supafunc import ...` to `from supabase_functions import ...`
+4. If `supafunc` is still used by one of your dependencies, consider reporting it in their issue tracker.
 
-## Usage
+## Reasoning
 
-Deploy your function as per documentation.
+The `supafunc` package has been replaced by the `supabase_functions` since December 14th, 2024, following the JavaScript implementation name switch. Changes and fixes were maintained for a couple of months by pushing them in both packages at the same time, using a patching script.
 
-
-```python3
-import asyncio
-from supafunc import AsyncFunctionsClient
-async def run_func():
-    fc = AsyncFunctionsClient("https://<project_ref>.functions.supabase.co", {})
-    res = await fc.invoke("payment-sheet", {"responseType": "json"})
-
-if __name__ == "__main__":
-    asyncio.run(run_func())
-```
+In order to simplify maintenance and development of new features, the `supafunc` package is going to cease receiving updates as of 7th of August 2025, and going forward everyone should use `supabase_functions` instead.

pyproject.toml

@@ -9,6 +9,9 @@ authors = [
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/supabase/functions-py"
+classifiers = [
+    "Development Status :: 7 - Inactive",
+]
 
 [tool.poetry.dependencies]
 python = "^3.9"

supafunc/__init__.py

@@ -1,4 +1,7 @@
 from __future__ import annotations
+import warnings
+
+warnings.warn('The `supafunc` package is deprecated, is not going to receive updates in the future. Please, use `supabase_functions` instead.', DeprecationWarning, stacklevel=2)
 
 from typing import Literal, Union, overload