FastPluggy 0.2.7__tar.gz

fastpluggy-0.2.7/MANIFEST.in

@@ -0,0 +1,12 @@
+# Include all Python files
+recursive-include src *.py
+
+# Include all template files
+recursive-include src/fastpluggy/templates *.html *.j2
+
+# Include all static files (CSS, JS, etc.)
+recursive-include src/fastpluggy/static *
+
+# Include README and license files
+include README.md
+include LICENSE

fastpluggy-0.2.7/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: FastPluggy
+Version: 0.2.7
+Summary: A FastAPI-based framework with plugin management and database handling.
+Home-page: https://gitlab.ggcorp.fr/open/fastpluggy/fast_pluggy
+Author: Your Name
+Author-email: your.email@example.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Requires-Dist: fastapi~=0.115.2
+Requires-Dist: starlette
+Requires-Dist: uvicorn>=0.31.1
+Requires-Dist: python-multipart
+Requires-Dist: pydantic
+Requires-Dist: pydantic-settings
+Requires-Dist: jinja2~=3.1.4
+Requires-Dist: sqlalchemy~=2.0.35
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: GitPython~=3.1.43
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: itsdangerous==2.1.0
+Requires-Dist: wtforms>=3.2.1
+Requires-Dist: werkzeug
+Requires-Dist: semantic-version
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

fastpluggy-0.2.7/README.md

@@ -0,0 +1,111 @@
+
+# FastPluggy
+
+**FastPluggy** is a FastAPI-based framework that simplifies the process of building modular applications with plugin management and database handling. It allows you to easily configure plugins, static files, Jinja2 templates, and databases, making it a powerful and flexible solution for FastAPI projects.
+
+## Features
+
+- **Plugin Management**: Easily manage, enable, disable, and configure plugins.
+- **Database Integration**: Supports SQLAlchemy for database handling.
+- **Static Files and Templates**: Serve static files and Jinja2 templates seamlessly.
+- **Extensibility**: Use FastPluggy as a library to extend your FastAPI applications.
+- **Simple Setup**: Configure your project with a single class, `ProjectSetup`, for easy initialization.
+
+## Installation
+
+You can install **FastPluggy** using pip:
+
+```bash
+pip install FastPluggy
+```
+
+## Getting Started
+
+### 1. Create a FastAPI App with FastPluggy
+
+In your FastAPI project, import `ProjectSetup` from **FastPluggy** and use it to configure your app:
+
+```python
+from fastapi import FastAPI
+from fastpluggy.fastpluggy import FastPluggy
+
+app = FastAPI()
+
+# Initialize the FastPluggy class which sets up everything
+fast_pluggy = FastPluggy(app)
+
+# Run the application using Uvicorn or another ASGI server
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(fast_pluggy.app, host="0.0.0.0", port=8000)
+
+```
+
+### 2. Running the Application
+
+Once the configuration is complete, you can run the FastAPI app using Uvicorn:
+
+```bash
+uvicorn your_project:app --reload
+```
+
+### 3. Plugin Management
+
+With **FastPluggy**, managing plugins is straightforward. The `PluginManager` class handles loading, enabling, disabling, and configuring plugins in your application. You can define plugins and control their behavior from the admin interface or directly in code.
+
+### Example Plugin Definition
+
+To create a plugin, simply create a Python module with a FastAPI router and define plugin-specific functionality.
+
+```python
+from fastapi import APIRouter
+
+plugin_router = APIRouter()
+
+@plugin_router.get("/hello")
+def hello_plugin():
+    return {"message": "Hello from the plugin!"}
+```
+
+**FastPluggy** will automatically detect and integrate this plugin into your application.
+
+## File Structure
+
+After installing **FastPluggy**, your project structure might look like this:
+
+```
+your_project/
+│
+├── src/
+│   ├── your_project/
+│   │   ├── __init__.py
+│   │   ├── main.py
+│   │   ├── core/
+│   │   ├── templates/
+│   │   ├── static/
+│   └── your_project.egg-info/
+│
+├── tests/
+├── README.md
+├── setup.py
+└── pyproject.toml
+```
+
+- **main.py**: Entry point for your application.
+- **core/**: Core logic for plugins, database handling, etc.
+- **templates/**: Jinja2 templates for rendering HTML.
+- **static/**: Static files like CSS and JavaScript.
+- **tests/**: Directory for unit tests.
+
+## Contributing
+
+Contributions are welcome! If you'd like to contribute to **FastPluggy**, please fork the repository and submit a pull request. Be sure to follow the contribution guidelines.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
+
+## Links
+
+- [Homepage](https://github.com/yourusername/fastpluggy)
+- [Documentation](https://github.com/yourusername/fastpluggy/wiki)

fastpluggy-0.2.7/pyproject.toml

@@ -0,0 +1,10 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+python_files = ["test_*.py"]
+python_functions = ["test_*"]

fastpluggy-0.2.7/setup.cfg

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

fastpluggy-0.2.7/setup.py

@@ -0,0 +1,38 @@
+import os
+
+from setuptools import setup, find_packages
+#from fastpluggy import __version__
+
+# Function to read the requirements from the requirements.txt file
+def parse_requirements(filename):
+    """Load requirements from a pip requirements file."""
+    with open(filename, 'r') as req_file:
+        return [line.strip() for line in req_file if line and not line.startswith("#")]
+
+
+requirements = []
+if os.path.isfile("requirements.txt"):
+    requirements = parse_requirements("requirements.txt")
+else:
+    print("requirements.txt not found")
+
+print(f"requirements: {requirements}")
+
+setup(
+    name='FastPluggy',
+    version="0.2.7",
+    description='A FastAPI-based framework with plugin management and database handling.',
+    author='Your Name',
+    author_email='your.email@example.com',
+    url='https://gitlab.ggcorp.fr/open/fastpluggy/fast_pluggy',
+    packages=find_packages(where='src'),  # This finds all packages under src/
+    package_dir={'': 'src'},  # Tells setuptools that all packages are under the src directory
+    include_package_data=True,  # This includes non-code files (static, templates)
+    install_requires=requirements,
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.7',
+)

fastpluggy-0.2.7/src/FastPluggy.egg-info/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: FastPluggy
+Version: 0.2.7
+Summary: A FastAPI-based framework with plugin management and database handling.
+Home-page: https://gitlab.ggcorp.fr/open/fastpluggy/fast_pluggy
+Author: Your Name
+Author-email: your.email@example.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Requires-Dist: fastapi~=0.115.2
+Requires-Dist: starlette
+Requires-Dist: uvicorn>=0.31.1
+Requires-Dist: python-multipart
+Requires-Dist: pydantic
+Requires-Dist: pydantic-settings
+Requires-Dist: jinja2~=3.1.4
+Requires-Dist: sqlalchemy~=2.0.35
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: GitPython~=3.1.43
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: itsdangerous==2.1.0
+Requires-Dist: wtforms>=3.2.1
+Requires-Dist: werkzeug
+Requires-Dist: semantic-version
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

fastpluggy-0.2.7/src/FastPluggy.egg-info/SOURCES.txt

@@ -0,0 +1,112 @@
+MANIFEST.in
+README.md
+pyproject.toml
+setup.py
+src/FastPluggy.egg-info/PKG-INFO
+src/FastPluggy.egg-info/SOURCES.txt
+src/FastPluggy.egg-info/dependency_links.txt
+src/FastPluggy.egg-info/requires.txt
+src/FastPluggy.egg-info/top_level.txt
+src/fastpluggy/__init__.py
+src/fastpluggy/fastpluggy.py
+src/fastpluggy/core/__init__.py
+src/fastpluggy/core/base_module.py
+src/fastpluggy/core/base_module_manager.py
+src/fastpluggy/core/config.py
+src/fastpluggy/core/database.py
+src/fastpluggy/core/dependency.py
+src/fastpluggy/core/flash.py
+src/fastpluggy/core/global_registry.py
+src/fastpluggy/core/models.py
+src/fastpluggy/core/module_base.py
+src/fastpluggy/core/plugin_state.py
+src/fastpluggy/core/auth/__init__.py
+src/fastpluggy/core/auth/auth_interface.py
+src/fastpluggy/core/auth/middleware.py
+src/fastpluggy/core/error/__init__.py
+src/fastpluggy/core/error/degraded_mode_handler.py
+src/fastpluggy/core/error/exception.py
+src/fastpluggy/core/menu/__init__.py
+src/fastpluggy/core/menu/decorator.py
+src/fastpluggy/core/menu/menu_manager.py
+src/fastpluggy/core/menu/schema.py
+src/fastpluggy/core/models_tools/__init__.py
+src/fastpluggy/core/models_tools/base.py
+src/fastpluggy/core/models_tools/callable.py
+src/fastpluggy/core/models_tools/pydantic.py
+src/fastpluggy/core/models_tools/shared.py
+src/fastpluggy/core/models_tools/sqlalchemy.py
+src/fastpluggy/core/plugin/__init__.py
+src/fastpluggy/core/plugin/dependency_resolver.py
+src/fastpluggy/core/plugin/repository.py
+src/fastpluggy/core/plugin/service.py
+src/fastpluggy/core/plugin/installer/__init__.py
+src/fastpluggy/core/plugin/installer/git_installer.py
+src/fastpluggy/core/plugin/installer/zip_installer.py
+src/fastpluggy/core/repository/__init__.py
+src/fastpluggy/core/repository/app_settings.py
+src/fastpluggy/core/routers/__init__.py
+src/fastpluggy/core/routers/admin.py
+src/fastpluggy/core/routers/app_static.py
+src/fastpluggy/core/routers/base_module.py
+src/fastpluggy/core/routers/execute.py
+src/fastpluggy/core/routers/home.py
+src/fastpluggy/core/routers/settings.py
+src/fastpluggy/core/routers/actions/__init__.py
+src/fastpluggy/core/routers/actions/fast_pluggy.py
+src/fastpluggy/core/routers/actions/modules.py
+src/fastpluggy/core/tools/__init__.py
+src/fastpluggy/core/tools/fastapi.py
+src/fastpluggy/core/tools/fs_tools.py
+src/fastpluggy/core/tools/git_tools.py
+src/fastpluggy/core/tools/inspect_tools.py
+src/fastpluggy/core/tools/install.py
+src/fastpluggy/core/tools/serialize_tools.py
+src/fastpluggy/core/tools/system.py
+src/fastpluggy/core/tools/threads_tools.py
+src/fastpluggy/core/view_builer/__init__.py
+src/fastpluggy/core/view_builer/form_builder.py
+src/fastpluggy/core/view_builer/components/__init__.py
+src/fastpluggy/core/view_builer/components/button.py
+src/fastpluggy/core/view_builer/components/custom.py
+src/fastpluggy/core/view_builer/components/debug.py
+src/fastpluggy/core/view_builer/components/form.py
+src/fastpluggy/core/view_builer/components/list.py
+src/fastpluggy/core/view_builer/components/model.py
+src/fastpluggy/core/view_builer/components/pagination.py
+src/fastpluggy/core/view_builer/components/raw.py
+src/fastpluggy/core/view_builer/components/render_field_tools.py
+src/fastpluggy/core/view_builer/components/tabbed.py
+src/fastpluggy/core/view_builer/components/table.py
+src/fastpluggy/core/view_builer/components/table_model.py
+src/fastpluggy/static/css/__init__.py
+src/fastpluggy/static/css/styles.css
+src/fastpluggy/static/js/__init__.py
+src/fastpluggy/static/js/scripts.js
+src/fastpluggy/templates/__init__.py
+src/fastpluggy/templates/base.html.j2
+src/fastpluggy/templates/degraded_mode.html.j2
+src/fastpluggy/templates/error.html.j2
+src/fastpluggy/templates/flash_messages.html.j2
+src/fastpluggy/templates/index.html.j2
+src/fastpluggy/templates/menu.html.j2
+src/fastpluggy/templates/admin/__init__.py
+src/fastpluggy/templates/admin/install_module.html.j2
+src/fastpluggy/templates/auth/__init__.py
+src/fastpluggy/templates/components/__init__.py
+src/fastpluggy/templates/components/button_component.html.j2
+src/fastpluggy/templates/components/common.html.j2
+src/fastpluggy/templates/components/form.html.j2
+src/fastpluggy/templates/components/form_component.html.j2
+src/fastpluggy/templates/components/generic_page.html.j2
+src/fastpluggy/templates/components/mime.html.j2
+src/fastpluggy/templates/components/model_view.html.j2
+src/fastpluggy/templates/components/pagination_macros.html.j2
+src/fastpluggy/templates/components/tabbed.html.j2
+src/fastpluggy/templates/components/table_component.html.j2
+src/fastpluggy/templates/components/table_filter_component.html.j2
+src/fastpluggy/templates/components/debug/json.html.j2
+tests/test_app.py
+tests/test_domain_module_manager.py
+tests/test_dynamic_settings.py
+tests/test_fast_pluggy_init.py

fastpluggy-0.2.7/src/FastPluggy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastpluggy-0.2.7/src/FastPluggy.egg-info/requires.txt

@@ -0,0 +1,15 @@
+fastapi~=0.115.2
+starlette
+uvicorn>=0.31.1
+python-multipart
+pydantic
+pydantic-settings
+jinja2~=3.1.4
+sqlalchemy~=2.0.35
+loguru>=0.7.2
+GitPython~=3.1.43
+httpx>=0.27.2
+itsdangerous==2.1.0
+wtforms>=3.2.1
+werkzeug
+semantic-version

fastpluggy-0.2.7/src/FastPluggy.egg-info/top_level.txt

@@ -0,0 +1 @@
+fastpluggy

fastpluggy-0.2.7/src/fastpluggy/__init__.py

@@ -0,0 +1,4 @@
+import os
+
+__version__ = "0.2.7"  # Update this manually when needed
+__SOURCE_COMMIT_CORE__ = os.getenv("SOURCE_COMMIT_CORE", "")

fastpluggy-0.2.7/src/fastpluggy/core/auth/__init__.py

@@ -0,0 +1,34 @@
+# core/dependency.py
+from fastapi import Request, HTTPException, Depends
+from starlette import status
+from starlette.authentication import UnauthenticatedUser
+
+
+async def require_authentication(request: Request):
+    auth_manager = request.app.state.fastpluggy.auth_manager
+    if auth_manager:
+        if isinstance(request.user, UnauthenticatedUser):
+            # If a custom error handler is defined, call it.
+            if hasattr(auth_manager, "on_authenticate_error") and callable(auth_manager.on_authenticate_error):
+                result = await auth_manager.on_authenticate_error(request)
+                if result is not None:
+                    return result
+
+            # Fallback to default behavior if no custom error handling was provided.
+            raise HTTPException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Not authenticated"
+            )
+        return request.user
+
+
+def require_role(role: str):
+    async def dependency(request: Request):
+        # your `require_authentication` should already have populated request.user & request.auth
+        # (e.g. via an AuthenticationMiddleware + your backend)
+        auth_manager = request.app.state.fastpluggy.auth_manager
+        if auth_manager:
+            scopes = getattr(request.auth, "scopes", [])
+            if role not in scopes:
+                raise HTTPException(status_code=403, detail=f"'{role}' role required")
+    return Depends(dependency)

fastpluggy-0.2.7/src/fastpluggy/core/auth/auth_interface.py

@@ -0,0 +1,78 @@
+from abc import abstractmethod
+from typing import Type
+
+from fastapi import Request
+from starlette.authentication import BaseUser, AuthenticationBackend, AuthCredentials
+from starlette.requests import HTTPConnection
+
+
+class AuthInterface(AuthenticationBackend):
+
+    async def on_authenticate_error(self, request: Request):
+        """
+        Handle authentication errors when a user fails to authenticate.
+
+        This method is invoked when authentication fails (e.g., due to missing or invalid credentials).
+        It examines the request's 'Accept' header and, if the client expects HTML and login redirection is enabled,
+        returns a redirect response to the login page. Otherwise, it raises an HTTP 401 Unauthorized exception with
+        a WWW-Authenticate header, which can trigger the browser's Basic Authentication popup.
+
+        Args:
+            request (Request): The incoming FastAPI request object containing details such as headers.
+
+        Returns:
+            A RedirectResponse if HTML is accepted and redirection is enabled. If not, this method raises an
+            HTTPException and does not return normally.
+
+        Raises:
+            HTTPException: Raised with status code 401 if authentication fails and the client does not accept HTML,
+            prompting the Basic Auth dialog.
+        """
+        pass
+
+    @property
+    @abstractmethod
+    def user_model(self) -> Type[BaseUser]:
+        """
+        Returns the SQLAlchemy model class representing a user.
+        Implementations can override this property to use a different model.
+        """
+        pass
+
+    @abstractmethod
+    async def authenticate(self, conn: HTTPConnection) -> tuple[AuthCredentials, BaseUser] | None:
+        """
+        Check if the user is authenticated.
+        Should return a User object if authenticated.
+        Otherwise, it can either raise an HTTPException or return a Response (e.g. a redirect).
+        """
+        pass
+
+    def get_user_menu_entries(self, request: Request) -> list:
+        """
+        Returns menu items for the user dropdown based on whether a user is logged in.
+            If a user is logged in, the menu is obtained from the FastPluggy menu manager (using the "user" menu).
+            Otherwise, a default login entry is returned.
+
+        Each menu item should be a dictionary containing keys such as:
+            - "name": the display text
+            - "icon": (optional) an icon class
+            - "url": the destination URL
+
+
+            """
+        # Check if a user is attached to request.state (set by middleware)
+        user = getattr(request.state, "current_user", None)
+        if user:
+            from fastpluggy.fastpluggy import FastPluggy
+
+            # Retrieve the menu manager from the app state.
+            fast_pluggy: FastPluggy = request.app.state.fastpluggy
+
+            menu_manager = fast_pluggy.menu_manager
+            # Try to get the "user" menu from the manager.
+            user_menu = menu_manager.get_menu("user")
+            return user_menu
+        else:
+            # If no user is logged in, return a default login entry.
+            return [{'router': {"name": "Login", "icon": "fa-solid fa-sign-in-alt", "url": "/login"}}]

fastpluggy-0.2.7/src/fastpluggy/core/auth/middleware.py

@@ -0,0 +1,31 @@
+from fastapi import Request
+from loguru import logger
+from starlette.middleware.base import BaseHTTPMiddleware
+
+
+class CurrentUserMiddleware(BaseHTTPMiddleware):
+    async def dispatch(self, request: Request, call_next):
+        # Obtain a DB session; in production you might want a better scoped session
+
+        from fastpluggy.fastpluggy import FastPluggy
+
+        # Retrieve the FastPluggy instance (assuming it's stored in app.state)
+        fast_pluggy: FastPluggy = request.app.state.fastpluggy
+        try:
+            # Use the current auth manager to authenticate the user
+            if fast_pluggy.auth_manager:
+                user = await fast_pluggy.auth_manager.authenticate(request)
+            else:
+                user = None
+        except Exception as e:
+            logger.exception(e)
+            user = None
+        # Attach the user to request.state
+        request.state.current_user = user[1] if user else None
+        request.state.roles = user[0] if user else None
+        if hasattr(fast_pluggy.auth_manager, 'get_user_menu_entries'):
+            request.state.user_menu = fast_pluggy.auth_manager.get_user_menu_entries(request)
+        else:
+            request.state.user_menu = []
+        response = await call_next(request)
+        return response

fastpluggy-0.2.7/src/fastpluggy/core/base_module.py

@@ -0,0 +1,73 @@
+import ast
+import os
+
+from loguru import logger
+
+
+class BaseModule:
+    def __init__(self):
+        self.requirements_installed = False
+
+        # self.package_name = f"{self.module_type}s.{name}"
+        self.url = "#"
+
+    def common_module_load_param(self):
+
+        #        self.files = list_modules_in_package(self.module.__path__)
+
+        # Detect models
+        self.discover_models()
+
+    def discover_models(self, base_class_name="Base"):
+        """
+        Discover SQLAlchemy models in a plugin's models.py file using AST.
+
+        Args:
+            base_class_name (str): Name of the SQLAlchemy base class (default is 'Base').
+        """
+        try:
+            # Construct the path to models.py
+            models_path = os.path.join(self.path, "models.py")
+            if not os.path.exists(models_path):
+                logger.debug(f"No models.py file found in module '{self.name}'.")
+                return
+
+            # Parse the models.py file using AST
+            with open(models_path, "r") as file:
+                tree = ast.parse(file.read())
+
+            for node in ast.walk(tree):
+                # Look for class definitions
+                if isinstance(node, ast.ClassDef):
+                    # Check if the class inherits from the specified base class
+                    for base in node.bases:
+                        if (
+                                isinstance(base, ast.Name) and base.id == base_class_name
+                        ) or (
+                                isinstance(base, ast.Attribute) and base.attr == base_class_name
+                        ):
+                            # Check for __tablename__ attribute
+                            tablename = None
+                            for body_item in node.body:
+                                if isinstance(body_item, ast.Assign):
+                                    for target in body_item.targets:
+                                        if (
+                                                isinstance(target, ast.Name)
+                                                and target.id == "__tablename__"
+                                        ):
+                                            if isinstance(body_item.value, ast.Constant):
+                                                tablename = body_item.value.value
+
+                            # Add the discovered model to the module's models
+                            self.models.append(
+                                {"class_name": node.name, "table_name": tablename,
+                                 "module_name": '.'.join([self.package_name, 'models'])}
+                            )
+                            logger.info(
+                                f"Discovered model '{node.name}' with table '{tablename}' in module '{self.name}'"
+                            )
+
+            if not self.models:
+                logger.debug(f"No SQLAlchemy models discovered in module '{self.name}'.")
+        except Exception as e:
+            logger.error(f"Error discovering models in module '{self.name}': {e}")