back_up: pre-start

README.md

@@ -32,51 +32,21 @@ ___
 
 ___
 
-### FastAPI&supabase
-
-1. works of authorization all handled by supabase-py and fastapi **dependency** without any extra code
-2. supabase-py crud integration with **pydantic** model validation
-
-### Pytest
-
-1. pytest integration with **pytest-cov**
-2. pytest **fixtures** for fastapi client and supabase client
-3. pytest **fixtures** for access_token and refresh_token
-4. test for **CRUD** operations
-5. test for **api** operations
-
-### CI/CD
-
-1. **codecov** for coverage report
-2. **poetry** for dependency management and pytest integration
-3. **pre-commit** for code quality
-4. **latest_changes.yml** for auto update README.md
-5. **Semantic Release** for auto release and changelog
-6. **docker** for deployment
-
 ## How to use it
 
-___
-![](docs/assets/usage.gif)
 
-1. create your github repo and config it
-   1. allow ci to access your repo
-      ![img.png](docs/assets/img.png)
-   2. config ci_tokens
-      1. `CODECOV_TOKEN` for codecov in `.github/workflows/ci.yml` ,`semantic-release` is optional for auto release
-      2. `ATTICUS_PAT`should replace with your GitHub token for latest_changes.yml in `.github/workflows/latest_changes.yml`
-      3. `DOCKER_USERNAME` and `DOCKER_PASSWORD` for docker-image.yml in `.github/workflows/docker-image.yml`
-      4. replace `tags: atticuszhou/supafast:latest` with your docker repo in `.github/workflows/docker-image.yml`
-   3. config fastapi setting in `your_project\src\app\core\config.py`
-   4. config `pyproject.toml` with your project name and description,etc
 
-2. cd your repo and install dependencies with [uv](https://github.com/astral-sh/uv), which is an extremely fast Python package and project manager, written in Rust.
+### install python dependencies
+
+cd your repo and install dependencies with [uv](https://github.com/astral-sh/uv), which is an extremely fast Python package and project manager, written in Rust.
 
 ```shell
 uv sync
 ```
 
-3. [start your supabase locally](https://supabase.com/docs/guides/local-development/cli/getting-started?queryGroups=platform&platform=linux&queryGroups=access-method&access-method=postgres)
+### install supabase
+
+1. [start your supabase locally](https://supabase.com/docs/guides/local-development/cli/getting-started?queryGroups=platform&platform=linux&queryGroups=access-method&access-method=postgres)
 
 ```bash
 # brew in linux https://brew.sh/
@@ -85,34 +55,17 @@ supabase init
 supabase start
 ```
 
-4. set your supabase env
+2. set your supabase env
 
 ```shell
 export SUPABASE_URL=your_supabase_url
 export SUPABASE_KEY=your_supabase_key
-export SUPERUSER_EMAIL=your_superuser_email
-export SUPERUSER_PASSWORD=your_superuser_password
 ```
 
-5. config fastapi settings
-
-```python
-# 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)
-```
 
-6. run server
+### run
+
+1. run server
 
 ```shell
 uv run uvicorn app.main:app --reload
@@ -123,63 +76,18 @@ uv run uvicorn app.main:app --reload
 ___
 
 - [x] FastAPI backend
-  - [x] **standard** structure
+  - [ ] Layered Architecture
       for <a href="https://github.com/tiangolo/fastapi" class="external-link" target="_blank">**FastAPI**</a> project
+  - [ ] sqlmodel ORM supabase
+    - [x] test_pre_start.py
+    - [ ] pre_start.py
+    - [ ] crud test
+  - [ ] api test
 
-  ```text
-  ── 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
-  ...
-  ```
-
-  - [x] **auto-auth** by fastapi dependency with supabase-auth
-  - [x] **CRUD** operations pytest
-  - [x] **api** requests pytest
 - [ ] Supabase integration
-  - [x] crud supabase-postgresql
+  - [ ] crud supabase-postgresql
   - [ ] websocket with supabase-realtime
   - [ ] curd supabase-storage
   - [ ] supafunc integration
-- [x] deployment
-  - [x] Full **Docker** integration (Docker based).
-- [ ] clone
-  - [ ] cookiecutter
-
-## Release Notes 🥸
-
-___
-
-### Latest Changes
-
-## License
-
-This project is licensed under the terms of the MIT license.
+- [ ] deployment
+  - [ ] Full **Docker** integration (Docker based).

backend/alembic.ini

@@ -0,0 +1,115 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = app/alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

backend/app/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

backend/app/alembic/env.py

@@ -0,0 +1,87 @@
+from logging.config import fileConfig
+
+from alembic import context
+from app.core.config import settings
+from app.models import *  # noqa: F403
+from sqlalchemy import engine_from_config, pool
+from sqlmodel import SQLModel
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+
+
+target_metadata = SQLModel.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+def get_url()-> str:
+    return str(settings.SQLALCHEMY_DATABASE_URI)
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = get_url()
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        compare_type=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    configuration = config.get_section(config.config_ini_section)
+    if configuration is None:
+        raise FileNotFoundError("alembic config is None!")
+    configuration["sqlalchemy.url"] = get_url()
+    connectable = engine_from_config(
+        configuration,
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection, target_metadata=target_metadata,compare_type=True,dialect_opts={"paramstyle": "named"},
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()
+