improving project configuration (#25)

* delete unused email configuration

* update the default env configuration file to `.env`

* update log file name configuration

* update alembic migration file naming style

* delete the comma after the env_file variable

Author: wu-clan

backend/app/.env.example

@@ -17,6 +17,3 @@ APS_REDIS_PASSWORD=''
 APS_REDIS_DATABASE=1
 # Token
 TOKEN_SECRET_KEY='1VkVF75nsNABBjK_7-qz7GtzNy3AMvktc9TCPwKczCk'
-# Email
-EMAIL_USER='xxxx-nav@qq.com'
-EMAIL_PASSWORD=''

backend/app/alembic.ini

@@ -5,7 +5,7 @@
 script_location = alembic
 
 # template used to generate migration files
-# file_template = %%(rev)s_%%(slug)s
+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.

backend/app/common/log.py

@@ -8,6 +8,7 @@
 from loguru import logger
 
 from backend.app.core import path_conf
+from backend.app.core.conf import settings
 
 
 class Logger:
@@ -17,7 +18,7 @@ def log() -> loguru.Logger:
             os.mkdir(path_conf.LogPath)
 
         # 日志文件
-        log_file = os.path.join(path_conf.LogPath, 'FastBlog.log')
+        log_file = os.path.join(path_conf.LogPath, settings.LOG_FILE_NAME)
 
         # loguru日志
         # more: https://github.com/Delgan/loguru#ready-to-use-out-of-the-box-without-boilerplate

backend/app/core/conf.py

@@ -31,10 +31,6 @@ class Settings(BaseSettings):
     # Env Token
     TOKEN_SECRET_KEY: str  # 密钥 secrets.token_urlsafe(32))
 
-    # Env Email
-    EMAIL_USER: str
-    EMAIL_PASSWORD: str  # 授权密码，非邮箱密码
-
     # FastAPI
     TITLE: str = 'FastAPI'
     VERSION: str = '0.0.1'
@@ -78,14 +74,8 @@ def validator_api_url(cls, values):
     TOKEN_EXPIRE_MINUTES: int = 60 * 24 * 1  # token 时效 60 * 24 * 1 = 1 天
     TOKEN_URL: str = '/v1/users/login'
 
-    # Email
-    EMAIL_DESCRIPTION: str = 'fastapi_sqlalchemy_mysql'  # 默认发件说明
-    EMAIL_SERVER: str = 'smtp.qq.com'
-    EMAIL_PORT: int = 465
-    EMAIL_SSL: bool = True
-
-    # Cookies
-    COOKIES_MAX_AGE: int = 60 * 5  # cookies 时效 60 * 5 = 5 分钟
+    # Log
+    LOG_FILE_NAME: str = 'fba.log'
 
     # Middleware
     MIDDLEWARE_CORS: bool = True
@@ -94,7 +84,7 @@ def validator_api_url(cls, values):
 
     class Config:
         # https://docs.pydantic.dev/usage/settings/#dotenv-env-support
-        env_file = '.env', '.env.example'
+        env_file = '.env'
         env_file_encoding = 'utf-8'
 
 

docker_conf.py

@@ -51,17 +51,6 @@ class Settings(BaseSettings):
     TOKEN_SECRET_KEY: str = '1VkVF75nsNABBjK_7-qz7GtzNy3AMvktc9TCPwKczCk'  # 密钥 secrets.token_urlsafe(32))
     TOKEN_EXPIRE_MINUTES: int = 60 * 24 * 1  # token 时效 60 * 24 * 1 = 1 天
 
-    # Email
-    EMAIL_DESCRIPTION: str = 'fastapi_sqlalchemy_mysql'  # 默认发件说明
-    EMAIL_SERVER: str = 'smtp.qq.com'
-    EMAIL_PORT: int = 465
-    EMAIL_USER: str = 'xxxx-nav@qq.com'
-    EMAIL_PASSWORD: str = ''  # 授权密码，非邮箱密码
-    EMAIL_SSL: bool = True  # 是否使用ssl
-
-    # 邮箱登录验证码过期时间
-    EMAIL_LOGIN_CODE_MAX_AGE: int = 60 * 2  # 时效 60 * 2 = 2 分钟
-
     # Cookies
     COOKIES_MAX_AGE: int = 60 * 5  # cookies 时效 60 * 5 = 5 分钟