fastapi-clean-archi 0.6.5__tar.gz

fastapi_clean_archi-0.6.5/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2025 YuJeonghoon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

fastapi_clean_archi-0.6.5/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include fastapi_clean_archi/managements/templates *.tmpl

fastapi_clean_archi-0.6.5/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: fastapi-clean-archi
+Version: 0.6.5
+Summary: FastAPI with clean architecture
+Author-email: YuJeonghoon <moning02004@naver.com>
+License: The MIT License
+        
+        Copyright (c) 2025 YuJeonghoon
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+Project-URL: Homepage, https://github.com/moning02004/fastapi-clean-archi
+Project-URL: Bug Tracker, https://github.com/moning02004/fastapi-clean-archi/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.121.3
+Requires-Dist: passlib
+Requires-Dist: uvicorn
+Requires-Dist: SQLAlchemy
+Requires-Dist: PyJWT
+Requires-Dist: pytest
+Requires-Dist: alembic
+Requires-Dist: python-dotenv
+Requires-Dist: bcrypt==4.0.1
+Requires-Dist: typer
+Requires-Dist: httpx
+Dynamic: license-file
+
+## FastAPI with Clean-Architecture
+> 클린 아키텍처 구조를 적용한 FastAPI.
+
+
+### Clean Architecture 구조 및 역할
+#### 흐름
+> interfaces -> application -> domain -> infrastructure
+
+#### 설명
+- 클린 아키텍처의 핵심은 관심사의 분리로 유지보수와 확장성을 높일 수 있다.
+
+| Layer       | Description                             |
+|-------------|-----------------------------------------|
+| Interface   | 사용자/외부 입력을 Application의 유즈케이스에 연결하는 레이어 | 
+| Application | 사용자 시나리오(usecase) 및 비즈니스 로직을 실행하는 레이어   |
+| Domain       | 핵심 비즈니스 규칙 및 엔티티를 정의하는 레이어              |
+| Infrastructure | 외부 시스템\(DB, API 등\)과의 연동 및 구현을 담당하는 레이어 |
+
+**예시** _by github copilot_
+- **Interface**: 사용자가 회원가입 폼을 제출하면, API 엔드포인트에서 입력 데이터를 받아 Application 레이어로 전달합니다.
+- **Application**: 회원가입 유즈케이스를 실행하며, 입력값 검증, 비밀번호 암호화, 도메인 객체 생성, 트랜잭션 관리 등을 처리합니다.
+- **Domain**: `User` 엔티티와 회원가입 관련 비즈니스 규칙(예: 이메일 중복 체크, 비밀번호 정책 등)을 정의합니다.
+- **Infrastructure**: DB에 사용자 정보를 저장하고, 이메일 인증을 위해 외부 메일 서비스와 연동합니다.
+
+
+---
+
+### 기본 사용법
+- fastapi-setup 으로 프로젝트 초기화할 수 있습니다.
+```bash
+fastapi-setup
+```
+
+- --help 를 통해 명령어를 확인할 수 있습니다.
+```bash
+python3 manage.py --help
+```
+
+### 커스텀 명령어 추가 방법
+- `{PROJECT_DIR}/managements/commands/` 아래 Command 를 상속받아 명령어를 추가할 수 있습니다.
+```bash
+python3 manage.py {command_name}
+```
+

fastapi_clean_archi-0.6.5/README.md

@@ -0,0 +1,44 @@
+## FastAPI with Clean-Architecture
+> 클린 아키텍처 구조를 적용한 FastAPI.
+
+
+### Clean Architecture 구조 및 역할
+#### 흐름
+> interfaces -> application -> domain -> infrastructure
+
+#### 설명
+- 클린 아키텍처의 핵심은 관심사의 분리로 유지보수와 확장성을 높일 수 있다.
+
+| Layer       | Description                             |
+|-------------|-----------------------------------------|
+| Interface   | 사용자/외부 입력을 Application의 유즈케이스에 연결하는 레이어 | 
+| Application | 사용자 시나리오(usecase) 및 비즈니스 로직을 실행하는 레이어   |
+| Domain       | 핵심 비즈니스 규칙 및 엔티티를 정의하는 레이어              |
+| Infrastructure | 외부 시스템\(DB, API 등\)과의 연동 및 구현을 담당하는 레이어 |
+
+**예시** _by github copilot_
+- **Interface**: 사용자가 회원가입 폼을 제출하면, API 엔드포인트에서 입력 데이터를 받아 Application 레이어로 전달합니다.
+- **Application**: 회원가입 유즈케이스를 실행하며, 입력값 검증, 비밀번호 암호화, 도메인 객체 생성, 트랜잭션 관리 등을 처리합니다.
+- **Domain**: `User` 엔티티와 회원가입 관련 비즈니스 규칙(예: 이메일 중복 체크, 비밀번호 정책 등)을 정의합니다.
+- **Infrastructure**: DB에 사용자 정보를 저장하고, 이메일 인증을 위해 외부 메일 서비스와 연동합니다.
+
+
+---
+
+### 기본 사용법
+- fastapi-setup 으로 프로젝트 초기화할 수 있습니다.
+```bash
+fastapi-setup
+```
+
+- --help 를 통해 명령어를 확인할 수 있습니다.
+```bash
+python3 manage.py --help
+```
+
+### 커스텀 명령어 추가 방법
+- `{PROJECT_DIR}/managements/commands/` 아래 Command 를 상속받아 명령어를 추가할 수 있습니다.
+```bash
+python3 manage.py {command_name}
+```
+

fastapi_clean_archi-0.6.5/fastapi_clean_archi/cli.py

@@ -0,0 +1,59 @@
+import argparse
+import re
+import secrets
+from importlib import resources
+from pathlib import Path
+
+from fastapi_clean_archi.managements.commands.base import copy_files, copy_file, run_alembic
+
+template_dir = resources.files("fastapi_clean_archi.managements.templates")
+
+
+def edit_file(filename, remove_line_words, add_lines, line_number):
+    path = Path(filename)
+    lines = path.read_text().splitlines()
+
+    for index in range(len(lines)):
+        for x in remove_line_words:
+            if lines[index].startswith(x):
+                lines[index] = ""
+    path.write_text("\n".join(lines[:line_number] + add_lines + lines[line_number:]))
+
+
+def create_core():
+    secret_key = secrets.token_urlsafe(32)
+    copy_files(source_dir=Path(f"{template_dir}/core"),
+               target_dir=Path("./app/core"),
+               secret_key=secret_key)
+
+    copy_file(file_path=Path(f"{template_dir}/__init__.tmpl"),
+              new_file_path=Path("./app/__init__.py"))
+
+    copy_file(file_path=Path(f"{template_dir}/main.tmpl"),
+              new_file_path=Path("./main.py"))
+
+    copy_file(file_path=Path(f"{template_dir}/pytest.tmpl"),
+              new_file_path=Path("./pytest.ini"))
+
+    copy_file(file_path=Path(f"{template_dir}/manage.tmpl"),
+              new_file_path=Path("./manage.py"))
+    run_alembic("alembic init migrations")
+
+    edit_file("./alembic.ini", remove_line_words=["sqlalchemy.url"], add_lines=[], line_number=0)
+    edit_file("./migrations/env.py", remove_line_words=["target_metadata = "], add_lines=[
+        "",
+        "from app.core.config import settings",
+        "config.set_main_option(\"sqlalchemy.url\", settings.DATABASE_URL)",
+        "",
+        "import os, importlib",
+        "modules = os.listdir(\"app/modules\")",
+        "for module in modules:",
+        "    try:",
+        "        importlib.import_module(f\"app.modules.{module}.infrastructure.models\")",
+        "    except ModuleNotFoundError:",
+        "        continue",
+        "",
+        "from fastapi_clean_archi.core.db.base import BaseModel",
+        "target_metadata = BaseModel.metadata"
+        "",
+    ], line_number=19)

fastapi_clean_archi-0.6.5/fastapi_clean_archi/core/auth.py

@@ -0,0 +1,14 @@
+from passlib.context import CryptContext
+
+pwd_context = CryptContext(
+    schemes=["argon2", "bcrypt"],
+    deprecated="auto",
+)
+
+
+def hash_password(password: str) -> str:
+    return pwd_context.hash(password)
+
+
+def verify_password(plain_password: str, hashed_password: str) -> bool:
+    return pwd_context.verify(plain_password, hashed_password)

fastapi_clean_archi-0.6.5/fastapi_clean_archi/core/commons/repository.py

@@ -0,0 +1,16 @@
+from sqlalchemy.orm import Session
+
+
+class Repository:
+    DB_MODEL = None
+
+    def __init__(self, db: Session):
+        self.db = db
+
+    def get_by_pk(self, pk: int | str):
+        instance = self.db.query(self.DB_MODEL).filter(self.DB_MODEL.pk == pk).first()
+        return instance
+
+    def get_by_hash_id(self, hash_id: str):
+        instance = self.db.query(self.DB_MODEL).filter(self.DB_MODEL.hash_id == hash_id).first()
+        return instance

fastapi_clean_archi-0.6.5/fastapi_clean_archi/core/commons/service.py

@@ -0,0 +1,3 @@
+class Service:
+    def __init__(self, repository):
+        self.repository = repository

fastapi_clean_archi-0.6.5/fastapi_clean_archi/core/config.py

@@ -0,0 +1,23 @@
+import os
+
+from pydantic.v1 import BaseSettings
+
+
+class AbstractSettings(BaseSettings):
+    DATABASE = {
+        "driver": "sqlite",
+        "name": "sqlite.db",
+        "user": "",
+        "password": "",
+        "host": "",
+        "port": "",
+    }
+
+    DATABASE_URL: str = (
+        f"{DATABASE['driver']}:///{DATABASE['name']}"
+        if DATABASE["driver"] == "sqlite"
+        else f"{DATABASE['driver']}://{DATABASE['user']}:{DATABASE['password']}@{DATABASE['host']}:{DATABASE['port']}/{DATABASE['name']}"
+    )
+
+    class Config:
+        env_file = os.environ.get("SETTINGS_ENV", ".env")

fastapi_clean_archi-0.6.5/fastapi_clean_archi/core/db/base.py

@@ -0,0 +1,40 @@
+import uuid
+
+from sqlalchemy import Column, Integer, DateTime, func, String, event
+from sqlalchemy.orm import as_declarative, declarative_base, declared_attr, Session
+
+Base = declarative_base()
+
+
+@as_declarative()
+class BaseModel(Base):
+    __abstract__ = True
+
+    hash_id = Column(String(100), nullable=False, unique=True)
+    created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
+    updated_at = Column(DateTime(timezone=True), server_default=func.now(), onupdate=func.now(), nullable=False)
+
+    @declared_attr
+    def __tablename__(cls):
+        meta = getattr(cls, "Meta", None)
+        if meta and hasattr(meta, "db_table"):
+            return meta.db_table
+        return cls.__name__.lower()
+
+    @declared_attr
+    def pk(cls):
+        for attr in cls.__dict__.values():
+            if isinstance(attr, Column) and attr.primary_key:
+                return Column("id", Integer, index=True, unique=True, autoincrement=True)
+        return Column("id", Integer, primary_key=True, index=True, unique=True, autoincrement=True)
+
+
+@event.listens_for(Session, "before_flush")
+def generate_hash_id(session, flush_context, instances):
+    for instance in session.new:
+        if instance.hash_id is None:
+            if getattr(instance, "user_id"):
+                hash_id = str(uuid.uuid3(uuid.NAMESPACE_OID, f"{instance.user_id}_{instance.pk}").hex)
+            else:
+                hash_id = str(uuid.uuid4().hex)
+            instance.hash_id = hash_id

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/commands/__init__.py

@@ -0,0 +1 @@
+from . import *

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/commands/add_module.py

@@ -0,0 +1,28 @@
+import os
+from importlib import resources
+from pathlib import Path
+
+import typer
+
+from fastapi_clean_archi.managements.commands.base import Command, copy_files, copy_file
+
+template_dir = resources.files("fastapi_clean_archi.managements.templates")
+
+
+class AddModule(Command):
+    name = "add_module"
+    help = "구조화된 모듈을 추가합니다."
+
+    def execute(self, module_name=typer.Argument(...)):
+        class_name = module_name.capitalize()
+        module_name = module_name.lower()
+
+        copy_files(source_dir=Path(f"{template_dir}/app_module"),
+                   target_dir=Path(f"./app/modules/{module_name}"),
+                   module_name=module_name,
+                   module_class=class_name)
+
+        if not os.path.exists("./app/modules/__init__.py"):
+            copy_file(file_path=Path(f"{template_dir}/__init__.tmpl"),
+                      new_file_path=Path("./app/modules/__init__.py"))
+

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/commands/base.py

@@ -0,0 +1,41 @@
+import abc
+import os
+import subprocess
+from abc import ABC
+
+
+class Command(ABC):
+    name: str = None
+    help: str = None
+
+    @abc.abstractmethod
+    def execute(self):
+        raise NotImplementedError
+
+
+def run_alembic(alembic_command: str):
+    subprocess.run(alembic_command.split(" "))
+
+
+def copy_file(file_path, new_file_path, **kwargs):
+    with open(file_path, 'r', encoding='utf-8') as f:
+        data = f.read().format(**kwargs)
+
+    with open(new_file_path, 'w', encoding='utf-8') as f:
+        f.write(data)
+    print(f"✅ Created {file_path}")
+
+
+def copy_files(source_dir, target_dir, **kwargs):
+    for file_path in source_dir.rglob('*'):
+        if file_path.is_file():
+            relative_path = file_path.relative_to(source_dir)
+            relative_path = relative_path.with_suffix(".py")
+            new_file_path = target_dir / relative_path
+
+            if os.path.isfile(new_file_path):
+                print(f"⚠️  {file_path} already exists, skipping")
+                continue
+
+            new_file_path.parent.mkdir(parents=True, exist_ok=True)
+            copy_file(file_path, new_file_path, **kwargs)

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/commands/makemigrations.py

@@ -0,0 +1,11 @@
+import typer
+
+from fastapi_clean_archi.managements.commands.base import Command, run_alembic
+
+
+class MakeMigrations(Command):
+    name = "makemigrations"
+    help = "db migration 파일을 생성합니다."
+
+    def execute(self, message=typer.Argument("auto_migration")):
+        run_alembic(f"alembic revision --autogenerate -m {message}")

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/commands/migrate.py

@@ -0,0 +1,9 @@
+from fastapi_clean_archi.managements.commands.base import run_alembic, Command
+
+
+class Migrate(Command):
+    name = "migrate"
+    help = "db migration 을 진행합니다."
+
+    def execute(self):
+        run_alembic("alembic upgrade head")

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/commands/runserver.py

@@ -0,0 +1,20 @@
+import os
+
+import typer
+import uvicorn
+
+from fastapi_clean_archi.managements.commands.base import Command
+
+
+class Runserver(Command):
+    name = "runserver"
+    help = "FastAPI server 가 실행됩니다."
+
+    def execute(self, host_port=typer.Argument(None), host=typer.Argument("localhost"), port=typer.Argument("8000"), settings_env=typer.Argument(".env")):
+        if host_port:
+            host, port = host_port.split(":")
+        else:
+            host, port = host, port
+
+        os.environ.setdefault("SETTINGS_ENV", settings_env)
+        uvicorn.run("main:app", host=host, port=int(port), reload=True)

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/commands/test.py

@@ -0,0 +1,30 @@
+import subprocess
+
+import typer
+
+from fastapi_clean_archi.managements.commands.base import Command
+
+
+class Test(Command):
+    name = "test"
+    help = "테스트를 실행합니다."
+
+    def execute(self,
+                module_name=typer.Argument("", help="테스트 대상 모듈 이름"),
+                test_name=typer.Argument("", help="테스트 파일 및 함수 이름. ex) filename, filename::function_name 형식으로 입력")):
+        if not module_name and test_name:
+            raise typer.BadParameter("모듈 이름이 필요합니다.")
+
+        specific_params = ""
+        if test_name:
+            test_filename, *test_function_name = test_name.split("::")
+            if not test_filename.endswith(".py"):
+                test_filename = f"{test_filename}.py"
+            test_function_name = test_function_name and test_function_name[0]
+            specific_params = f"{test_filename}::{test_function_name}" if test_function_name else test_filename
+
+        params = f"app/modules/{module_name}/tests/{specific_params}" if module_name else ""
+
+        command = f"pytest {params}".strip()
+        subprocess.run(command, shell=True)
+        print(f"Pytest Command is \"{command}\"")

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/app_module/application/service.tmpl

@@ -0,0 +1,5 @@
+from fastapi_clean_archi.core.commons.service import Service
+
+
+class {module_class}Service(Service):
+    pass

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/app_module/domain/entity.tmpl

@@ -0,0 +1,6 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class {module_class}Entity:
+    pk: int

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/app_module/infrastructure/models.tmpl

@@ -0,0 +1,5 @@
+from fastapi_clean_archi.core.db.base import BaseModel
+
+
+class {module_class}(BaseModel):
+    pass

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/app_module/infrastructure/repository.tmpl

@@ -0,0 +1,7 @@
+from fastapi_clean_archi.core.commons.repository import Repository
+
+from app.modules.{module_name}.infrastructure.models import {module_class}
+
+
+class {module_class}Repository(Repository):
+    DB_MODEL = {module_class}

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/app_module/interfaces/controller.tmpl

@@ -0,0 +1,3 @@
+from fastapi import APIRouter
+
+router = APIRouter(prefix="", tags=[])

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/app_module/interfaces/schemas.tmpl

@@ -0,0 +1 @@
+import pydantic

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/app_module/tests/test.tmpl

@@ -0,0 +1,9 @@
+from fastapi.testclient import TestClient
+
+from main import app
+
+client = TestClient(app)
+
+
+def test_is_true():
+    assert 1 == 1

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/core/config.tmpl

@@ -0,0 +1,30 @@
+from fastapi_clean_archi.core.config import AbstractSettings
+
+
+class Settings(AbstractSettings):
+    APP_NAME: str = "FastAPI clean architecture"
+
+    # JWT settings
+    ALGORITHM: str = "HS256"
+    ACCESS_TOKEN_EXPIRE_MINUTES: str = "1D"
+    REFRESH_TOKEN_EXPIRE_MINUTES: str = "30D"
+
+    # Application settings
+    DEBUG: bool = True
+    SECRET_KEY: str = "{secret_key}"
+
+    # Database settings
+    DATABASE = {{
+        "driver": "sqlite",
+        "name": "sqlite.db",
+        "user": "",
+        "password": "",
+        "host": "",
+        "port": "",
+    }}
+
+    # CORS settings
+    CORS_ORIGINS = []
+
+
+settings = Settings()

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/core/jwt_util.tmpl

@@ -0,0 +1,45 @@
+from copy import deepcopy
+from datetime import datetime, timedelta
+
+from app.core.config import settings
+import jwt
+
+
+class JWTManager:
+    current_time = None
+
+    def get_payload(self, data, value):
+        payload = deepcopy(data)
+        number, _type = value[:-1], value[-1]
+        _type = _type.upper()
+
+        if _type == "D":
+            timedelta_params = {{"days": int(number)}}
+        elif _type == "M":
+            timedelta_params = {{"minutes": int(number)}}
+        elif _type == "S":
+            timedelta_params = {{"seconds": int(number)}}
+        else:
+            timedelta_params = {{"seconds": 3600}}
+        expired_at = self.current_time + timedelta(**timedelta_params)
+
+        payload.update({{"exp": int(expired_at.timestamp())}})
+        payload.update({{"iat": int(self.current_time.timestamp())}})
+        return payload
+
+    def create(self, data):
+        self.current_time = datetime.now()
+
+        access_payload = self.get_payload(data, settings.ACCESS_TOKEN_EXPIRE_MINUTES)
+        refresh_payload = self.get_payload(data, settings.REFRESH_TOKEN_EXPIRE_MINUTES)
+
+        return {{
+            "access_token": jwt.encode(access_payload, settings.SECRET_KEY, algorithm=settings.ALGORITHM),
+            "refresh_token": jwt.encode(refresh_payload, settings.SECRET_KEY, algorithm=settings.ALGORITHM)
+        }}
+
+    def decode_payload(self, token: str) -> dict:
+        return jwt.decode(token, settings.SECRET_KEY, algorithms=[settings.ALGORITHM])
+
+
+jwt_manager = JWTManager()

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/core/session.tmpl

@@ -0,0 +1,17 @@
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+from app.core.config import settings
+
+engine = create_engine(settings.DATABASE_URL)
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+
+def get_db():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()
+
+    

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/main.tmpl

@@ -0,0 +1,20 @@
+from fastapi import FastAPI, Depends
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.security import APIKeyHeader
+
+from app.core.config import settings
+
+auth_header = APIKeyHeader(name="Authorization", auto_error=False)
+app = FastAPI(
+    dependencies=[Depends(auth_header)]
+)
+
+origins = []
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=settings.CORS_ORIGINS,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/manage.tmpl

@@ -0,0 +1,35 @@
+import importlib
+import pkgutil
+
+import typer
+from fastapi_clean_archi.managements.commands.base import Command
+
+command_app = typer.Typer()
+
+
+def auto_register_commands():
+    import fastapi_clean_archi.managements.commands as commands
+    for _, mod, _ in pkgutil.iter_modules(commands.__path__):
+        importlib.import_module(f"fastapi_clean_archi.managements.commands.{{mod}}")
+        for cls in Command.__subclasses__():
+            command_class = cls()
+            command_app.command(command_class.name)(command_class.execute)
+
+
+def register_custom_commands():
+    try:
+        import managements.commands as commands
+    except ImportError:
+        return
+
+    for _, mod, _ in pkgutil.iter_modules(commands.__path__):
+        importlib.import_module(f"managements.commands.{{mod}}")
+        for cls in Command.__subclasses__():
+            command_class = cls()
+            command_app.command(command_class.name)(command_class.execute)
+
+
+if __name__ == "__main__":
+    auto_register_commands()
+    register_custom_commands()
+    command_app()

fastapi_clean_archi-0.6.5/fastapi_clean_archi/managements/templates/pytest.tmpl

@@ -0,0 +1,8 @@
+[pytest]
+addopts = -ra -vv
+
+testpaths = app/modules tests
+
+python_files = test_*.py test.py *_test.py
+python_classes = Test*
+python_functions = test_*

fastapi_clean_archi-0.6.5/fastapi_clean_archi.egg-info/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: fastapi-clean-archi
+Version: 0.6.5
+Summary: FastAPI with clean architecture
+Author-email: YuJeonghoon <moning02004@naver.com>
+License: The MIT License
+        
+        Copyright (c) 2025 YuJeonghoon
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+Project-URL: Homepage, https://github.com/moning02004/fastapi-clean-archi
+Project-URL: Bug Tracker, https://github.com/moning02004/fastapi-clean-archi/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.121.3
+Requires-Dist: passlib
+Requires-Dist: uvicorn
+Requires-Dist: SQLAlchemy
+Requires-Dist: PyJWT
+Requires-Dist: pytest
+Requires-Dist: alembic
+Requires-Dist: python-dotenv
+Requires-Dist: bcrypt==4.0.1
+Requires-Dist: typer
+Requires-Dist: httpx
+Dynamic: license-file
+
+## FastAPI with Clean-Architecture
+> 클린 아키텍처 구조를 적용한 FastAPI.
+
+
+### Clean Architecture 구조 및 역할
+#### 흐름
+> interfaces -> application -> domain -> infrastructure
+
+#### 설명
+- 클린 아키텍처의 핵심은 관심사의 분리로 유지보수와 확장성을 높일 수 있다.
+
+| Layer       | Description                             |
+|-------------|-----------------------------------------|
+| Interface   | 사용자/외부 입력을 Application의 유즈케이스에 연결하는 레이어 | 
+| Application | 사용자 시나리오(usecase) 및 비즈니스 로직을 실행하는 레이어   |
+| Domain       | 핵심 비즈니스 규칙 및 엔티티를 정의하는 레이어              |
+| Infrastructure | 외부 시스템\(DB, API 등\)과의 연동 및 구현을 담당하는 레이어 |
+
+**예시** _by github copilot_
+- **Interface**: 사용자가 회원가입 폼을 제출하면, API 엔드포인트에서 입력 데이터를 받아 Application 레이어로 전달합니다.
+- **Application**: 회원가입 유즈케이스를 실행하며, 입력값 검증, 비밀번호 암호화, 도메인 객체 생성, 트랜잭션 관리 등을 처리합니다.
+- **Domain**: `User` 엔티티와 회원가입 관련 비즈니스 규칙(예: 이메일 중복 체크, 비밀번호 정책 등)을 정의합니다.
+- **Infrastructure**: DB에 사용자 정보를 저장하고, 이메일 인증을 위해 외부 메일 서비스와 연동합니다.
+
+
+---
+
+### 기본 사용법
+- fastapi-setup 으로 프로젝트 초기화할 수 있습니다.
+```bash
+fastapi-setup
+```
+
+- --help 를 통해 명령어를 확인할 수 있습니다.
+```bash
+python3 manage.py --help
+```
+
+### 커스텀 명령어 추가 방법
+- `{PROJECT_DIR}/managements/commands/` 아래 Command 를 상속받아 명령어를 추가할 수 있습니다.
+```bash
+python3 manage.py {command_name}
+```
+

fastapi_clean_archi-0.6.5/fastapi_clean_archi.egg-info/SOURCES.txt

@@ -0,0 +1,50 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+fastapi_clean_archi/__init__.py
+fastapi_clean_archi/cli.py
+fastapi_clean_archi.egg-info/PKG-INFO
+fastapi_clean_archi.egg-info/SOURCES.txt
+fastapi_clean_archi.egg-info/dependency_links.txt
+fastapi_clean_archi.egg-info/entry_points.txt
+fastapi_clean_archi.egg-info/requires.txt
+fastapi_clean_archi.egg-info/top_level.txt
+fastapi_clean_archi/core/__init__.py
+fastapi_clean_archi/core/auth.py
+fastapi_clean_archi/core/config.py
+fastapi_clean_archi/core/commons/__init__.py
+fastapi_clean_archi/core/commons/repository.py
+fastapi_clean_archi/core/commons/service.py
+fastapi_clean_archi/core/db/__init__.py
+fastapi_clean_archi/core/db/base.py
+fastapi_clean_archi/managements/__init__.py
+fastapi_clean_archi/managements/commands/__init__.py
+fastapi_clean_archi/managements/commands/add_module.py
+fastapi_clean_archi/managements/commands/base.py
+fastapi_clean_archi/managements/commands/makemigrations.py
+fastapi_clean_archi/managements/commands/migrate.py
+fastapi_clean_archi/managements/commands/runserver.py
+fastapi_clean_archi/managements/commands/test.py
+fastapi_clean_archi/managements/templates/__init__.py
+fastapi_clean_archi/managements/templates/__init__.tmpl
+fastapi_clean_archi/managements/templates/main.tmpl
+fastapi_clean_archi/managements/templates/manage.tmpl
+fastapi_clean_archi/managements/templates/pytest.tmpl
+fastapi_clean_archi/managements/templates/app_module/__init__.tmpl
+fastapi_clean_archi/managements/templates/app_module/application/__init__.tmpl
+fastapi_clean_archi/managements/templates/app_module/application/service.tmpl
+fastapi_clean_archi/managements/templates/app_module/domain/__init__.tmpl
+fastapi_clean_archi/managements/templates/app_module/domain/entity.tmpl
+fastapi_clean_archi/managements/templates/app_module/infrastructure/__init__.tmpl
+fastapi_clean_archi/managements/templates/app_module/infrastructure/models.tmpl
+fastapi_clean_archi/managements/templates/app_module/infrastructure/repository.tmpl
+fastapi_clean_archi/managements/templates/app_module/interfaces/__init__.tmpl
+fastapi_clean_archi/managements/templates/app_module/interfaces/controller.tmpl
+fastapi_clean_archi/managements/templates/app_module/interfaces/schemas.tmpl
+fastapi_clean_archi/managements/templates/app_module/tests/__init__.tmpl
+fastapi_clean_archi/managements/templates/app_module/tests/test.tmpl
+fastapi_clean_archi/managements/templates/core/__init__.tmpl
+fastapi_clean_archi/managements/templates/core/config.tmpl
+fastapi_clean_archi/managements/templates/core/jwt_util.tmpl
+fastapi_clean_archi/managements/templates/core/session.tmpl

fastapi_clean_archi-0.6.5/fastapi_clean_archi.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastapi_clean_archi-0.6.5/fastapi_clean_archi.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fastapi-setup = fastapi_clean_archi.cli:create_core

fastapi_clean_archi-0.6.5/fastapi_clean_archi.egg-info/requires.txt

@@ -0,0 +1,11 @@
+fastapi>=0.121.3
+passlib
+uvicorn
+SQLAlchemy
+PyJWT
+pytest
+alembic
+python-dotenv
+bcrypt==4.0.1
+typer
+httpx

fastapi_clean_archi-0.6.5/fastapi_clean_archi.egg-info/top_level.txt

@@ -0,0 +1 @@
+fastapi_clean_archi

fastapi_clean_archi-0.6.5/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fastapi-clean-archi"
+version = "0.6.5"
+description = "FastAPI with clean architecture"
+license = {file = "LICENSE"}
+authors = [{name="YuJeonghoon", email="moning02004@naver.com"}]
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "fastapi>=0.121.3",
+    "passlib",
+    "uvicorn",
+    "SQLAlchemy",
+    "PyJWT",
+    "pytest",
+    "alembic",
+    "python-dotenv",
+    "bcrypt==4.0.1",
+    "typer",
+    "httpx"
+]
+
+[project.scripts]
+fastapi-setup = "fastapi_clean_archi.cli:create_core"
+
+[tool.setuptools.packages.find]
+include = ["fastapi_clean_archi*"]
+
+[project.urls]
+"Homepage" = "https://github.com/moning02004/fastapi-clean-archi"
+"Bug Tracker" = "https://github.com/moning02004/fastapi-clean-archi/issues"

fastapi_clean_archi-0.6.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+