fred-framework 1.0.0__tar.gz

fred_framework-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Your Name
+
+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.

fred_framework-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+include requirements.txt
+recursive-include fred/common/font *

fred_framework-1.0.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: fred-framework
+Version: 1.0.0
+Summary: A Flask-based web framework with built-in utilities and extensions
+Home-page: https://github.com/yourusername/fred-framework
+Author: Your Name
+Author-email: Your Name <your.email@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/yourusername/fred-framework
+Project-URL: Repository, https://github.com/yourusername/fred-framework
+Project-URL: Documentation, https://github.com/yourusername/fred-framework#readme
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask>=3.1.2
+Requires-Dist: flask_cors>=6.0.1
+Requires-Dist: flask_jwt_extended>=4.7.1
+Requires-Dist: Pillow>=11.3.0
+Requires-Dist: flask_smorest>=0.46.2
+Requires-Dist: flask_swagger_ui>=5.21.0
+Requires-Dist: cryptography>=44.0.3
+Requires-Dist: requests>=2.32.5
+Requires-Dist: flask_apscheduler>=1.13.1
+Requires-Dist: flask_babelplus>=2.2.0
+Requires-Dist: flask_sqlacodegen>=2.0.0
+Requires-Dist: flask_sqlalchemy>=3.1.1
+Requires-Dist: pymysql>=1.1.2
+Requires-Dist: pytz>=2025.2
+Requires-Dist: flask_mail>=0.10.0
+Requires-Dist: redis>=7.0.0
+Requires-Dist: apache-iotdb>=2.0.5
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Fred Framework
+
+Fred是一个基于Flask的Web框架，内置了常用的工具和扩展，帮助开发者快速构建Web应用程序。
+
+## 功能特性
+
+- 基于Flask的轻量级Web框架
+- 内置JWT认证支持
+- 数据库ORM支持（SQLAlchemy）
+- Redis集成
+- 邮件发送功能
+- 定时任务调度
+- 国际化支持
+- Swagger API文档
+- 图片验证码生成
+- 阿里云短信服务集成
+- 微信登录集成
+- 数据加密功能
+- 日志系统
+
+## 安装
+
+```bash
+pip install fred
+```
+
+## 快速开始
+
+```python
+from fred import create_app
+
+app = create_app()
+
+if __name__ == "__main__":
+    app.run(debug=True)
+```
+
+## 配置
+
+在使用Fred框架前，请根据需要修改`config/Config.py`中的配置项。
+
+## 依赖
+
+Fred框架依赖以下第三方库：
+
+- Flask >= 3.1.2
+- flask_cors >= 6.0.1
+- flask_jwt_extended >= 4.7.1
+- Pillow >= 11.3.0
+- flask_smorest >= 0.46.2
+- flask_swagger_ui >= 5.21.0
+- cryptography >= 44.0.3
+- requests >= 2.32.5
+- flask_apscheduler >= 1.13.1
+- flask_babelplus >= 2.2.0
+- flask_sqlacodegen >= 2.0.0
+- flask_sqlalchemy >= 3.1.1
+- pymysql >= 1.1.2
+- pytz >= 2025.2
+- flask_mail >= 0.10.0
+- redis >= 7.0.0
+
+## 打包和发布
+
+### 打包项目
+
+使用以下命令来打包项目：
+
+```bash
+# 使用 setuptools 打包
+python setup.py sdist bdist_wheel
+
+# 或者使用 build 工具 (推荐)
+pip install build
+python -m build
+```
+
+打包后的文件将位于 `dist/` 目录下。
+
+### 发布到 PyPI
+
+1. 首先安装 `twine` 工具：
+   ```bash
+   pip install twine
+   ```
+
+2. 上传到 PyPI：
+   ```bash
+   # 上传到正式 PyPI (需要 PyPI 账户)
+   twine upload dist/*
+   
+   # 或上传到测试 PyPI 进行测试
+   twine upload --repository testpypi dist/*
+   ```
+
+### 本地开发安装
+
+对于本地开发，可以使用以下命令以可编辑模式安装：
+
+```bash
+pip install -e .
+```
+
+这将创建一个指向源代码的链接，使代码更改无需重新安装即可生效。
+
+## 打包和发布
+
+### 打包项目
+
+使用以下命令来打包项目：
+
+```bash
+# 使用 setuptools 打包
+python setup.py sdist bdist_wheel
+
+# 或者使用 build 工具 (推荐)
+pip install build
+python -m build
+```
+
+打包后的文件将位于 `dist/` 目录下。
+
+### 发布到 PyPI
+
+1. 首先安装 `twine` 工具：
+   ```bash
+   pip install twine
+   ```
+
+2. 上传到 PyPI：
+   ```bash
+   # 上传到正式 PyPI (需要 PyPI 账户)
+   twine upload dist/*
+   
+   # 或上传到测试 PyPI 进行测试
+   twine upload --repository testpypi dist/*
+   ```
+
+### 本地开发安装
+
+对于本地开发，可以使用以下命令以可编辑模式安装：
+
+```bash
+pip install -e .
+```
+
+这将创建一个指向源代码的链接，使代码更改无需重新安装即可生效。
+
+## 许可证
+
+MIT License

fred_framework-1.0.0/README.md

@@ -0,0 +1,151 @@
+# Fred Framework
+
+Fred是一个基于Flask的Web框架，内置了常用的工具和扩展，帮助开发者快速构建Web应用程序。
+
+## 功能特性
+
+- 基于Flask的轻量级Web框架
+- 内置JWT认证支持
+- 数据库ORM支持（SQLAlchemy）
+- Redis集成
+- 邮件发送功能
+- 定时任务调度
+- 国际化支持
+- Swagger API文档
+- 图片验证码生成
+- 阿里云短信服务集成
+- 微信登录集成
+- 数据加密功能
+- 日志系统
+
+## 安装
+
+```bash
+pip install fred
+```
+
+## 快速开始
+
+```python
+from fred import create_app
+
+app = create_app()
+
+if __name__ == "__main__":
+    app.run(debug=True)
+```
+
+## 配置
+
+在使用Fred框架前，请根据需要修改`config/Config.py`中的配置项。
+
+## 依赖
+
+Fred框架依赖以下第三方库：
+
+- Flask >= 3.1.2
+- flask_cors >= 6.0.1
+- flask_jwt_extended >= 4.7.1
+- Pillow >= 11.3.0
+- flask_smorest >= 0.46.2
+- flask_swagger_ui >= 5.21.0
+- cryptography >= 44.0.3
+- requests >= 2.32.5
+- flask_apscheduler >= 1.13.1
+- flask_babelplus >= 2.2.0
+- flask_sqlacodegen >= 2.0.0
+- flask_sqlalchemy >= 3.1.1
+- pymysql >= 1.1.2
+- pytz >= 2025.2
+- flask_mail >= 0.10.0
+- redis >= 7.0.0
+
+## 打包和发布
+
+### 打包项目
+
+使用以下命令来打包项目：
+
+```bash
+# 使用 setuptools 打包
+python setup.py sdist bdist_wheel
+
+# 或者使用 build 工具 (推荐)
+pip install build
+python -m build
+```
+
+打包后的文件将位于 `dist/` 目录下。
+
+### 发布到 PyPI
+
+1. 首先安装 `twine` 工具：
+   ```bash
+   pip install twine
+   ```
+
+2. 上传到 PyPI：
+   ```bash
+   # 上传到正式 PyPI (需要 PyPI 账户)
+   twine upload dist/*
+   
+   # 或上传到测试 PyPI 进行测试
+   twine upload --repository testpypi dist/*
+   ```
+
+### 本地开发安装
+
+对于本地开发，可以使用以下命令以可编辑模式安装：
+
+```bash
+pip install -e .
+```
+
+这将创建一个指向源代码的链接，使代码更改无需重新安装即可生效。
+
+## 打包和发布
+
+### 打包项目
+
+使用以下命令来打包项目：
+
+```bash
+# 使用 setuptools 打包
+python setup.py sdist bdist_wheel
+
+# 或者使用 build 工具 (推荐)
+pip install build
+python -m build
+```
+
+打包后的文件将位于 `dist/` 目录下。
+
+### 发布到 PyPI
+
+1. 首先安装 `twine` 工具：
+   ```bash
+   pip install twine
+   ```
+
+2. 上传到 PyPI：
+   ```bash
+   # 上传到正式 PyPI (需要 PyPI 账户)
+   twine upload dist/*
+   
+   # 或上传到测试 PyPI 进行测试
+   twine upload --repository testpypi dist/*
+   ```
+
+### 本地开发安装
+
+对于本地开发，可以使用以下命令以可编辑模式安装：
+
+```bash
+pip install -e .
+```
+
+这将创建一个指向源代码的链接，使代码更改无需重新安装即可生效。
+
+## 许可证
+
+MIT License

fred_framework-1.0.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fred-framework"
+version = "1.0.0"
+authors = [
+    {name = "Your Name", email = "your.email@example.com"},
+]
+description = "A Flask-based web framework with built-in utilities and extensions"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+    "flask>=3.1.2",
+    "flask_cors>=6.0.1",
+    "flask_jwt_extended>=4.7.1",
+    "Pillow>=11.3.0",
+    "flask_smorest>=0.46.2",
+    "flask_swagger_ui>=5.21.0",
+    "cryptography>=44.0.3",
+    "requests>=2.32.5",
+    "flask_apscheduler>=1.13.1",
+    "flask_babelplus>=2.2.0",
+    "flask_sqlacodegen>=2.0.0",
+    "flask_sqlalchemy>=3.1.1",
+    "pymysql>=1.1.2",
+    "pytz>=2025.2",
+    "flask_mail>=0.10.0",
+    "redis>=7.0.0",
+    "apache-iotdb>=2.0.5",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=6.0", "black", "flake8"]
+
+[project.urls]
+Homepage = "https://github.com/yourusername/fred-framework"
+Repository = "https://github.com/yourusername/fred-framework"
+Documentation = "https://github.com/yourusername/fred-framework#readme"
+
+[project.scripts]
+fred-run = "fred:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["fred*"]
+namespaces = false
+
+[tool.setuptools.package-data]
+fred = ["common/font/*"]

fred_framework-1.0.0/requirements.txt

@@ -0,0 +1,39 @@
+# Fred Framework Dependencies
+#
+# This file lists the dependencies required by the Fred Framework.
+# These dependencies are also defined in setup.py and pyproject.toml.
+# Use this file for development purposes or when installing with pip install -r requirements.txt
+
+#-------------------以下是必须的包----------------
+# Flask 是一个轻量级的 WSGI 网络应用框架，用于快速构建 Web 应用程序
+flask>=3.1.2
+# 解决跨域资源共享（CORS）问题，使得前端可以跨域请求后端API
+flask_cors>=6.0.1
+# 提供对 JSON Web Tokens (JWT) 的支持，用于实现用户认证和授权
+flask_jwt_extended>=4.7.1
+# Python Imaging Library (PIL) 的一个分支，提供了图像处理能力
+Pillow>=11.3.0
+# 为 Flask 提供 API 版本控制、分组和 OpenAPI 文档生成功能
+flask_smorest>=0.46.2
+# swagger_ui
+flask_swagger_ui>=5.21.0
+# 提供了低级别的加密原语和高级别的加密库，用于数据安全
+cryptography>=44.0.3
+requests>=2.32.5
+# 为 Flask 应用添加 APScheduler 定时任务功能，允许开发者设置周期性执行的任务
+flask_apscheduler>=1.13.1
+# 扩展 Flask 的国际化和本地化支持，方便多语言网站开发
+flask_babelplus>=2.2.0
+# 根据数据库结构生成 SQLAlchemy 模型代码，加速开发过程
+flask_sqlacodegen>=2.0.0
+ # Flask 的 SQLAlchemy 扩展，简化了数据库操作
+flask_sqlalchemy>=3.1.1
+# MySQL 数据库的纯 Python 驱动，用于与 MySQL 数据库交互
+pymysql>=1.1.2
+# 提供世界时区定义、转换和 daylight savings 时间调整
+pytz>=2025.2
+# 为 Flask 应用添加邮件发送功能，简化电子邮件的发送过程
+flask_mail>=0.10.0
+# Flask 的 Redis 扩展，简化了与 Redis 数据库的连接和操作
+redis>=7.0.0
+#-------------------以下是可选包----------------

fred_framework-1.0.0/setup.cfg

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

fred_framework-1.0.0/setup.py

@@ -0,0 +1,120 @@
+from setuptools import setup, find_packages
+from setuptools.command.install import install
+from setuptools.command.egg_info import egg_info
+import sys
+import os
+from pathlib import Path
+
+# 读取README.md内容
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+# 读取requirements.txt内容
+with open("requirements.txt", "r", encoding="utf-8") as fh:
+    requirements = [line.strip() for line in fh.readlines() if line.strip() and not line.startswith("#")]
+
+
+class EggInfoCommand(egg_info):
+    """
+    自定义 egg_info 命令，将 egg-info 目录生成到项目根目录而不是 src 目录
+    """
+    def initialize_options(self):
+        egg_info.initialize_options(self)
+        # 设置 egg_base 为项目根目录（setup.py 所在目录）
+        self.egg_base = os.path.dirname(os.path.abspath(__file__))
+
+
+class PostInstallCommand(install):
+    """
+    安装后执行的自定义命令
+    在项目根目录创建必要的目录结构
+    """
+    def _find_project_root(self):
+        """
+        查找项目根目录（包含 setup.py 或 run.py 的目录）
+        """
+        # 从当前工作目录开始查找
+        current = Path.cwd()
+        
+        # 检查当前目录是否是项目根目录
+        if (current / 'setup.py').exists() or (current / 'run.py').exists():
+            return current
+        
+        # 向上查找，最多查找 5 层
+        for _ in range(5):
+            if (current / 'setup.py').exists() or (current / 'run.py').exists():
+                return current
+            parent = current.parent
+            if parent == current:  # 已到达根目录
+                break
+            current = parent
+        
+        # 如果找不到，返回当前工作目录
+        return Path.cwd()
+    
+    def run(self):
+        # 执行标准安装
+        install.run(self)
+        
+        # 执行安装后操作
+        try:
+            # 导入安装钩子函数
+            from fred.install_hook import create_project_directories
+            
+            # 查找项目根目录
+            project_root = self._find_project_root()
+            
+            # 切换到项目根目录执行
+            original_cwd = os.getcwd()
+            try:
+                os.chdir(project_root)
+                print(f'\n正在项目根目录创建目录结构: {project_root}')
+                create_project_directories()
+            finally:
+                os.chdir(original_cwd)
+                
+        except Exception as e:
+            # 安装后操作失败不应该影响安装本身
+            print(f'\n警告: 执行安装后操作时出错: {e}', file=sys.stderr)
+            print('提示: 你可以手动运行以下命令创建目录结构:', file=sys.stderr)
+            print('  python3 -c "from fred.install_hook import create_project_directories; create_project_directories()"', file=sys.stderr)
+
+
+setup(
+    name="fred-framework",
+    version="1.0.0",
+    author="Your Name",
+    author_email="your.email@example.com",
+    description="A Flask-based web framework with built-in utilities and extensions",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/yourusername/fred-framework",  # 请替换为实际的仓库地址
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+    ],
+    python_requires=">=3.8",
+    install_requires=requirements,
+    entry_points={
+        "console_scripts": [
+            "fred-run=fred:main",
+        ],
+    },
+    include_package_data=True,
+    package_data={
+        "fred": ["common/font/*"],
+    },
+    cmdclass={
+        'egg_info': EggInfoCommand,
+        'install': PostInstallCommand,
+    },
+)

fred_framework-1.0.0/src/fred/__init__.py

@@ -0,0 +1,96 @@
+import importlib
+import os
+from pathlib import Path
+
+from flask import Flask
+from flask_cors import CORS
+
+from fred.common.Blueprints import Blueprints
+from fred.common.Extensions import Extensions
+from fred.common.HandleExcetion import HandleException
+from fred.common.Response import Response
+from fred.common.Route import Route
+from fred.common.Swagger import Swagger
+from fred.common.Utils import Utils
+from fred.config.Config import Config
+from fred.config.Logger import Logger
+
+# 用于标记是否已经尝试创建目录，避免重复执行
+_initialized = False
+
+
+def create_app():
+    """
+    创建应用
+    """
+    # 在创建应用时自动创建项目目录结构（仅执行一次）
+    global _initialized
+    if not _initialized:
+        try:
+            from fred.install_hook import create_project_directories
+            # 获取项目根目录（当前工作目录）
+            project_root = Path.cwd()
+            # 检查是否是项目根目录（有 run.py 或 setup.py）
+            if (project_root / 'run.py').exists() or (project_root / 'setup.py').exists():
+                # 检查是否已经创建过（通过检查 config/Config.py 是否存在）
+                if not (project_root / 'config' / 'Config.py').exists():
+                    create_project_directories()
+        except Exception:
+            # 安装钩子执行失败不应该影响应用创建
+            pass
+        finally:
+            _initialized = True
+    
+    app = Flask(__name__)
+    
+    app.config.from_object(Config)
+    
+    app.config['SECRET_KEY'] = Utils.get_secret_key('session_secret_key')
+    if app.config['ENCRYPT_DATA']:  # 如果启用数据加密才生成fernet_key
+        app.config['FERNET_KEY'] = Utils.get_secret_key('fernet_key')
+    try:
+        config_module = importlib.import_module('config.Config')
+        Custom_Config = getattr(config_module, 'Config')
+        config_msg = "加载自定义Config,自定义配置会覆盖默认配置"
+        app.config.from_object(Custom_Config)
+    except (ImportError, AttributeError) as e:
+        # 可以选择记录日志或者静默跳过
+        config_msg = "没有配置自定义Config"
+    # 配置app.logger
+    Logger.set_logger(app)
+    
+    app.logger.debug(config_msg)
+    # 初始化组件
+    Extensions(app).initialize_extensions()
+    
+    # 注册蓝图
+    Blueprints(app).register_blueprints()
+    
+    # 设置默认路由 后端和swagger
+    Route(app).set_routes()
+    
+    # 启用 swagger
+    Swagger(app)
+    # 全局异常处理
+    HandleException(app)
+    # 重新定义模板文件路径
+    
+    # 自定义输出格式
+    Response().custom_response(app)
+    
+    if app.debug:
+        CORS(app, supports_credentials=True)
+    
+    return app
+
+
+def main():
+    """
+    主函数，用于启动应用
+    """
+    app = create_app()
+    app.run()
+
+
+if __name__ == '__main__':
+    main()