FastAPI-fastkit 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

fastapi_fastkit/core/settings.py

@@ -1,155 +1,155 @@
-# --------------------------------------------------------------------------
-# The Module defines fastapi-fastkit project's general Env settings.
-#
-# @author bnbong bbbong9@gmail.com
-# --------------------------------------------------------------------------
-import os
-from pathlib import Path
-
-from .exceptions import BackendExceptions
-
-
-class FastkitConfig:
-    # Overridable values
-    FASTKIT_PROJECT_ROOT: str = ""  # default : None (will be overridden)
-    FASTKIT_TEMPLATE_ROOT: str = ""  # default : None (will be overridden)
-    LOG_FILE_PATH: str = ""  # default : None (will be overridden)
-    USER_WORKSPACE: str = ""  # default : None (will be overridden)
-
-    # Default Options
-    DEBUG_MODE: bool = False
-    LOGGING_LEVEL: str = "DEBUG"
-
-    # Template Metadata Options
-    TEMPLATE_PATHS: dict[str, list[str] | dict[str, list[str]]] = {
-        "main": [
-            "src/main.py",
-            "main.py",
-        ],
-        "setup": [
-            "setup.py",
-            "src/setup.py",
-        ],
-        "config": {
-            "files": ["settings.py", "config.py"],
-            "paths": [
-                "src/core",
-                "src",
-                "",
-            ],
-        },
-    }
-
-    # Startproject Options
-    PROJECT_STACKS: dict[str, list[str]] = {
-        "minimal": ["fastapi", "uvicorn", "pydantic", "pydantic-settings"],
-        "standard": [
-            "fastapi",
-            "uvicorn",
-            "sqlalchemy",
-            "alembic",
-            "pytest",
-            "pydantic",
-            "pydantic-settings",
-        ],
-        "full": [
-            "fastapi",
-            "uvicorn",
-            "sqlalchemy",
-            "alembic",
-            "pytest",
-            "redis",
-            "celery",
-            "pydantic",
-            "pydantic-settings",
-        ],
-    }
-
-    # Testing Options
-    TEST_SERVER_PORT: int = 8000
-    TEST_DEFAULT_TERMINAL_WIDTH: int = 80
-    TEST_MAX_TERMINAL_WIDTH: int = 1000
-
-    def set_debug_mode(self, debug_mode: bool = True) -> None:
-        self.DEBUG_MODE = debug_mode
-
-    @staticmethod
-    def __get_fastapi_fastkit_root() -> Path:
-        """
-        Returns the root directory of the installed FastAPI-fastkit package.
-        For development: returns the project root
-        For installed package: returns the package installation directory
-        """
-        try:
-            import fastapi_fastkit
-
-            package_root = Path(fastapi_fastkit.__file__).parent.parent
-            if package_root.name == "site-packages":
-                return package_root / "fastapi_fastkit"
-            return package_root
-        except ImportError:
-            # Fallback for development environment
-            return Path(__file__).parent.parent.parent.parent
-
-    @staticmethod
-    def __get_template_root() -> Path:
-        """
-        Returns the template directory of the installed FastAPI-fastkit package.
-        For development: returns the project template directory
-        For installed package: returns the package template directory
-        """
-        try:
-            import fastapi_fastkit
-
-            package_root = Path(fastapi_fastkit.__file__).parent
-            template_dir = package_root / "fastapi_project_template"
-            if template_dir.exists():
-                return template_dir
-            # If inside site-packages
-            if package_root.parent.name == "site-packages":
-                return (
-                    package_root.parent / "fastapi_fastkit" / "fastapi_project_template"
-                )
-            return package_root.parent / "fastapi_project_template"
-        except ImportError:
-            # Fallback for development environment
-            return Path(__file__).parent.parent / "fastapi_project_template"
-
-    @classmethod
-    def __init__(cls) -> None:
-        """
-        Initialize the configuration by performing important checks and setups.
-        Override directories to correct position.
-        """
-        cls.FASTKIT_PROJECT_ROOT = str(cls.__get_fastapi_fastkit_root())
-        cls.FASTKIT_TEMPLATE_ROOT = str(cls.__get_template_root())
-        cls.LOG_FILE_PATH = os.path.join(
-            cls.FASTKIT_PROJECT_ROOT, "logs", "fastkit.log"
-        )
-        cls.USER_WORKSPACE = os.getcwd()
-
-        # Validate the configurations
-        cls._validate()
-
-    @classmethod
-    def _validate(cls) -> None:
-        """
-        Validate the configuration settings to ensure that they are correct.
-        Raises an error if validation fails.
-        """
-        if not cls.FASTKIT_PROJECT_ROOT or not os.path.isdir(cls.FASTKIT_PROJECT_ROOT):
-            raise BackendExceptions(
-                "FASTKIT_PROJECT_ROOT is not allocated to valid directory."
-            )
-
-        if not cls.FASTKIT_TEMPLATE_ROOT or not os.path.isdir(cls.FASTKIT_PROJECT_ROOT):
-            raise BackendExceptions(
-                "FASTKIT_TEMPLATE_ROOT is not allocated to valid directory."
-            )
-
-        log_dir = os.path.dirname(cls.LOG_FILE_PATH)
-        if not os.path.exists(log_dir):
-            os.makedirs(log_dir)
-
-
-settings = FastkitConfig()
+# --------------------------------------------------------------------------
+# The Module defines fastapi-fastkit project's general Env settings.
+#
+# @author bnbong bbbong9@gmail.com
+# --------------------------------------------------------------------------
+import os
+from pathlib import Path
+
+from .exceptions import BackendExceptions
+
+
+class FastkitConfig:
+    # Overridable values
+    FASTKIT_PROJECT_ROOT: str = ""  # default : None (will be overridden)
+    FASTKIT_TEMPLATE_ROOT: str = ""  # default : None (will be overridden)
+    LOG_FILE_PATH: str = ""  # default : None (will be overridden)
+    USER_WORKSPACE: str = ""  # default : None (will be overridden)
+
+    # Default Options
+    DEBUG_MODE: bool = False
+    LOGGING_LEVEL: str = "DEBUG"
+
+    # Template Metadata Options
+    TEMPLATE_PATHS: dict[str, list[str] | dict[str, list[str]]] = {
+        "main": [
+            "src/main.py",
+            "main.py",
+        ],
+        "setup": [
+            "setup.py",
+            "src/setup.py",
+        ],
+        "config": {
+            "files": ["settings.py", "config.py"],
+            "paths": [
+                "src/core",
+                "src",
+                "",
+            ],
+        },
+    }
+
+    # Startproject Options
+    PROJECT_STACKS: dict[str, list[str]] = {
+        "minimal": ["fastapi", "uvicorn", "pydantic", "pydantic-settings"],
+        "standard": [
+            "fastapi",
+            "uvicorn",
+            "sqlalchemy",
+            "alembic",
+            "pytest",
+            "pydantic",
+            "pydantic-settings",
+        ],
+        "full": [
+            "fastapi",
+            "uvicorn",
+            "sqlalchemy",
+            "alembic",
+            "pytest",
+            "redis",
+            "celery",
+            "pydantic",
+            "pydantic-settings",
+        ],
+    }
+
+    # Testing Options
+    TEST_SERVER_PORT: int = 8000
+    TEST_DEFAULT_TERMINAL_WIDTH: int = 80
+    TEST_MAX_TERMINAL_WIDTH: int = 1000
+
+    def set_debug_mode(self, debug_mode: bool = True) -> None:
+        self.DEBUG_MODE = debug_mode
+
+    @staticmethod
+    def __get_fastapi_fastkit_root() -> Path:
+        """
+        Returns the root directory of the installed FastAPI-fastkit package.
+        For development: returns the project root
+        For installed package: returns the package installation directory
+        """
+        try:
+            import fastapi_fastkit
+
+            package_root = Path(fastapi_fastkit.__file__).parent.parent
+            if package_root.name == "site-packages":
+                return package_root / "fastapi_fastkit"
+            return package_root
+        except ImportError:
+            # Fallback for development environment
+            return Path(__file__).parent.parent.parent.parent
+
+    @staticmethod
+    def __get_template_root() -> Path:
+        """
+        Returns the template directory of the installed FastAPI-fastkit package.
+        For development: returns the project template directory
+        For installed package: returns the package template directory
+        """
+        try:
+            import fastapi_fastkit
+
+            package_root = Path(fastapi_fastkit.__file__).parent
+            template_dir = package_root / "fastapi_project_template"
+            if template_dir.exists():
+                return template_dir
+            # If inside site-packages
+            if package_root.parent.name == "site-packages":
+                return (
+                    package_root.parent / "fastapi_fastkit" / "fastapi_project_template"
+                )
+            return package_root.parent / "fastapi_project_template"
+        except ImportError:
+            # Fallback for development environment
+            return Path(__file__).parent.parent / "fastapi_project_template"
+
+    @classmethod
+    def __init__(cls) -> None:
+        """
+        Initialize the configuration by performing important checks and setups.
+        Override directories to correct position.
+        """
+        cls.FASTKIT_PROJECT_ROOT = str(cls.__get_fastapi_fastkit_root())
+        cls.FASTKIT_TEMPLATE_ROOT = str(cls.__get_template_root())
+        cls.LOG_FILE_PATH = os.path.join(
+            cls.FASTKIT_PROJECT_ROOT, "logs", "fastkit.log"
+        )
+        cls.USER_WORKSPACE = os.getcwd()
+
+        # Validate the configurations
+        cls._validate()
+
+    @classmethod
+    def _validate(cls) -> None:
+        """
+        Validate the configuration settings to ensure that they are correct.
+        Raises an error if validation fails.
+        """
+        if not cls.FASTKIT_PROJECT_ROOT or not os.path.isdir(cls.FASTKIT_PROJECT_ROOT):
+            raise BackendExceptions(
+                "FASTKIT_PROJECT_ROOT is not allocated to valid directory."
+            )
+
+        if not cls.FASTKIT_TEMPLATE_ROOT or not os.path.isdir(cls.FASTKIT_PROJECT_ROOT):
+            raise BackendExceptions(
+                "FASTKIT_TEMPLATE_ROOT is not allocated to valid directory."
+            )
+
+        log_dir = os.path.dirname(cls.LOG_FILE_PATH)
+        if not os.path.exists(log_dir):
+            os.makedirs(log_dir)
+
+
+settings = FastkitConfig()

fastapi_fastkit/fastapi_project_template/README.md

@@ -1,90 +1,90 @@
-# About fastapi project templates
-
-Each fastapi demo project in this folder is pasted to the user's local folder with the FastAPI-fastkit replication as the source code is.
-
-For those with experience in developing Django, it is easy to understand that it performs a similar operation to the `$ django-admin startproject <project-name>` cli-operation.
-
-All source codes in demo projects must consist of **`.py-tpl`**, _not_ .py.
-
-## Base structure of FastAPI template project
-
-### Required Structure
-
-```
-template-name/
-├── src/
-│ ├── main.py-tpl
-│ ├── config/
-│ ├── models/
-│ ├── routes/
-│ └── utils/
-├── tests/
-├── scripts/
-├── requirements.txt-tpl
-├── setup.py-tpl
-└── README.md-tpl
-```
-
-### Key Requirements:
-
-1. All source files must use `.py-tpl` extension
-2. `setup.py` must include `fastapi-fastkit` string in project description
-   for example:
-   ```
-   ...
-   setup(
-      ...
-      description = "[fastapi-fastkit templated] <description>",
-      ...
-   )
-   ```
-3. `setup.py` must include `install_requires` section, it must include essential dependencies for the template project. Also, note that install_requires list must be type annotated.
-   for example:
-   ```
-   ...
-   install_requires: list[str] = [
-      ...
-   ],
-   ```
-4. Basic CRUD operations example
-5. Unit tests implementation
-6. API documentation (OpenAPI/Swagger)
-
-## Base structure of modules template
-
-This template is used to create a new FastAPI project with a specific module structure.
-
-This template strategy is used at `fastkit addroute` operation.
-
-The module structure is as follows (version 1.0.X based):
-
-```
-modules/
-├── api/
-├── crud/
-└── schemas/
-```
-
-In further versions, I don't have any plan to add other modules to this template, for example, `auth`, `db`, etc.
-
-So, if you have any suggestions, please let me know or contribute to this operation.
-
-
-## Adding new FastAPI-based template project
-
-Before adding new FastAPI-based template project here, I strongly recommend that you read the
-[SECURITY.md](../SECURITY.md) and [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) files to understand
-the direction of this project and the precautions for cooperation.
-
-Follow these steps when adding a new template:
-
-1. Follow template structure
-2. Pass inspector.py tests
-3. Meet security requirements
-4. Pre-PR checklist:
-   - [ ] All files use .py-tpl extension
-   - [ ] FastAPI-fastkit dependency included
-   - [ ] Security requirements met
-   - [ ] Tests implemented and passing
-   - [ ] Documentation complete
-   - [ ] inspector.py validation passes
+# About fastapi project templates
+
+Each fastapi demo project in this folder is pasted to the user's local folder with the FastAPI-fastkit replication as the source code is.
+
+For those with experience in developing Django, it is easy to understand that it performs a similar operation to the `$ django-admin startproject <project-name>` cli-operation.
+
+All source codes in demo projects must consist of **`.py-tpl`**, _not_ .py.
+
+## Base structure of FastAPI template project
+
+### Required Structure
+
+```
+template-name/
+├── src/
+│ ├── main.py-tpl
+│ ├── config/
+│ ├── models/
+│ ├── routes/
+│ └── utils/
+├── tests/
+├── scripts/
+├── requirements.txt-tpl
+├── setup.py-tpl
+└── README.md-tpl
+```
+
+### Key Requirements:
+
+1. All source files must use `.py-tpl` extension
+2. `setup.py` must include `fastapi-fastkit` string in project description
+   for example:
+   ```
+   ...
+   setup(
+      ...
+      description = "[fastapi-fastkit templated] <description>",
+      ...
+   )
+   ```
+3. `setup.py` must include `install_requires` section, it must include essential dependencies for the template project. Also, note that install_requires list must be type annotated.
+   for example:
+   ```
+   ...
+   install_requires: list[str] = [
+      ...
+   ],
+   ```
+4. Basic CRUD operations example
+5. Unit tests implementation
+6. API documentation (OpenAPI/Swagger)
+
+## Base structure of modules template
+
+This template is used to create a new FastAPI project with a specific module structure.
+
+This template strategy is used at `fastkit addroute` operation.
+
+The module structure is as follows (version 1.0.X based):
+
+```
+modules/
+├── api/
+├── crud/
+└── schemas/
+```
+
+In further versions, I don't have any plan to add other modules to this template, for example, `auth`, `db`, etc.
+
+So, if you have any suggestions, please let me know or contribute to this operation.
+
+
+## Adding new FastAPI-based template project
+
+Before adding new FastAPI-based template project here, I strongly recommend that you read the
+[SECURITY.md](../SECURITY.md) and [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) files to understand
+the direction of this project and the precautions for cooperation.
+
+Follow these steps when adding a new template:
+
+1. Follow template structure
+2. Pass inspector.py tests
+3. Meet security requirements
+4. Pre-PR checklist:
+   - [ ] All files use .py-tpl extension
+   - [ ] FastAPI-fastkit dependency included
+   - [ ] Security requirements met
+   - [ ] Tests implemented and passing
+   - [ ] Documentation complete
+   - [ ] inspector.py validation passes

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/.env-tpl

@@ -1 +1 @@
-SECRET_KEY=changethis
+SECRET_KEY=changethis

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/.gitignore-tpl

@@ -1,30 +1,30 @@
-.idea
-.ipynb_checkpoints
-.mypy_cache
-.vscode
-__pycache__
-.pytest_cache
-htmlcov
-dist
-site
-.coverage*
-coverage.xml
-.netlify
-test.db
-log.txt
-Pipfile.lock
-env3.*
-env
-docs_build
-site_build
-venv
-docs.zip
-archive.zip
-
-# vim temporary files
-*~
-.*.sw?
-.cache
-
-# macOS
-.DS_Store
+.idea
+.ipynb_checkpoints
+.mypy_cache
+.vscode
+__pycache__
+.pytest_cache
+htmlcov
+dist
+site
+.coverage*
+coverage.xml
+.netlify
+test.db
+log.txt
+Pipfile.lock
+env3.*
+env
+docs_build
+site_build
+venv
+docs.zip
+archive.zip
+
+# vim temporary files
+*~
+.*.sw?
+.cache
+
+# macOS
+.DS_Store