chore: rename package to supabase_functions (#37)

Author: Andrew Smith

.github/workflows/ci.yml

@@ -88,8 +88,18 @@ jobs:
           fetch-depth: 0
           token: ${{ secrets.SILENTWORKS_PAT }}
 
+      - name: Rename Project
+        id: rename_project
+        run: make rename_project
+
+      - name: Python Semantic Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v8.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         # NOTE: DO NOT wrap the conditional in ${{ }} as it will always evaluate to true.
         # See https://github.com/actions/runner/issues/1173
-        if: needs.publish.release.outputs.released == 'true'
+        if: steps.release.outputs.released == 'true'

Makefile

@@ -16,4 +16,12 @@ tests_only:
 	poetry run pytest --cov=./ --cov-report=xml --cov-report=html -vv
 
 build_sync:
-	poetry run unasync supafunc tests
+	poetry run unasync supabase_functions tests
+
+rename_project: rename_package_dir rename_package
+
+rename_package_dir:
+	mv supabase_functions supafunc
+
+rename_package:
+	sed -i 's/supabase_functions/supafunc/g' pyproject.toml tests/_async/clients.py tests/_sync/clients.py tests/_async/test_function_client.py tests/_sync/test_function_client.py

README.md

@@ -3,7 +3,7 @@
 
 ## Installation
 
-`pip3 install supafunc`
+`pip3 install supabase_functions`
 
 ## Usage
 
@@ -12,7 +12,7 @@ Deploy your function as per documentation.
 
 ```python3
 import asyncio
-from supafunc import AsyncFunctionsClient
+from supabase_functions import AsyncFunctionsClient
 async def run_func():
     fc = AsyncFunctionsClient("https://<project_ref>.functions.supabase.co", {})
     res = await fc.invoke("payment-sheet", {"responseType": "json"})

supafunc/__init__.py renamed to supabase_functions/__init__.py

@@ -44,7 +44,9 @@ def set_auth(self, token: str) -> None:
 
         self.headers["Authorization"] = f"Bearer {token}"
 
-    def invoke(self, function_name: str, invoke_options: Optional[Dict] = None) -> Dict:
+    def invoke(
+        self, function_name: str, invoke_options: Optional[Dict] = None
+    ) -> Union[Dict, bytes]:
         """Invokes a function
 
         Parameters
@@ -54,11 +56,6 @@ def invoke(self, function_name: str, invoke_options: Optional[Dict] = None) -> D
             `headers`: object representing the headers to send with the request
             `body`: the body of the request
             `responseType`: how the response should be parsed. The default is `json`
-
-        Returns
-        -------
-        Dict
-            Dictionary with data
         """
         headers = self.headers
         if invoke_options is not None: