supabase & fastapi crud template
- works of authorization all handled by supabase-py and fastapi dependency without any extra code
- supabase-py crud integration with pydantic model validation
- pytest integration with pytest-cov
- pytest fixtures for fastapi client and supabase client
- pytest fixtures for access_token and refresh_token
- test for CRUD operations
- test for api operations
- codecov for coverage report
- poetry for dependency management and pytest integration
- pre-commit for code quality
- latest_changes.yml for auto update README.md
- Semantic Release for auto release and changelog
- docker for deployment
- create your github repo and config it
- allow ci to access your repo
- config ci_tokens
CODECOV_TOKENfor codecov in.github/workflows/ci.yml,semantic-releaseis optional for auto releaseATTICUS_PATshould replace with your GitHub token for latest_changes.yml in.github/workflows/latest_changes.ymlDOCKER_USERNAMEandDOCKER_PASSWORDfor docker-image.yml in.github/workflows/docker-image.yml- replace
tags: atticuszhou/supafast:latestwith your docker repo in.github/workflows/docker-image.yml
- config fastapi setting in
your_project\src\app\core\config.py - config
pyproject.tomlwith your project name and description,etc
- allow ci to access your repo
- cd your repo and install dependencies
poetry install- set your supabase env
export SUPABASE_URL=your_supabase_url
export SUPABASE_KEY=your_supabase_key
export SUPERUSER_EMAIL=your_superuser_email
export SUPERUSER_PASSWORD=your_superuser_password- config fastapi settings
# src/app/core/config.py
class Settings(BaseSettings):
API_V1_STR: str = "/api/v1"
SUPABASE_URL: str = Field(default_factory=lambda: os.getenv("SUPABASE_URL"))
SUPABASE_KEY: str = Field(default_factory=lambda: os.getenv("SUPABASE_KEY"))
SUPERUSER_EMAIL: str = Field(default_factory=lambda: os.getenv("SUPERUSER_EMAIL"))
SUPERUSER_PASSWORD: str = Field(default=lambda: os.getenv("SUPERUSER_PASSWORD"))
# SERVER_NAME: str
SERVER_HOST: AnyHttpUrl = "https://localhost"
SERVER_PORT: int = 8000
BACKEND_CORS_ORIGINS: list[AnyHttpUrl] = []
PROJECT_NAME: str = "fastapi supabase template"
Config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True)- run server
poetry run uvicorn src.app.main:app --reload- FastAPI backend
- standard structure for FastAPI project
── src │ └── app │ ├── api │ │ ├── api_v1 │ │ │ ├── endpoints │ │ │ │ ├── __init__.py │ │ │ │ └── items.py │ │ │ ├── __init__.py │ │ │ └── api.py │ │ ├── __init__.py │ │ └── deps.py │ ├── core │ │ ├── __init__.py │ │ ├── config.py │ │ └── events.py │ ├── crud │ │ ├── __init__.py │ │ ├── base.py │ │ └── crud_item.py │ ├── schemas │ │ ├── __init__.py │ │ ├── auth.py │ │ ├── base.py │ │ ├── item.py │ │ └── msg.py │ ├── services │ │ └── __init__.py │ ├── utils │ │ └── __init__.py │ ├── __init__.py │ └── main.py ...- auto-auth by fastapi dependency with supabase-auth
- CRUD operations pytest
- api requests pytest
- Supabase integration
- crud supabase-postgresql
- websocket with supabase-realtime
- curd supabase-storage
- supafunc integration
- deployment
- Full Docker integration (Docker based).
- clone
- cookiecutter
This project is licensed under the terms of the MIT license.