Bloomerp 1.0.0.dev23__tar.gz → 1.0.0.dev24__tar.gz

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/Bloomerp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Bloomerp
-Version: 1.0.0.dev23
+Version: 1.0.0.dev24
 Summary: Bloomerp is an open-source Business Management Software framework that lets you create fully functional business management applications just by defining your Django database models.
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/Bloomerp.egg-info/SOURCES.txt

@@ -85,6 +85,7 @@ bloomerp/management/commands/get_urls.py
 bloomerp/management/commands/save_application_fields.py
 bloomerp/management/commands/validate_bloomerp.py
 bloomerp/migrations/0001_initial.py
+bloomerp/migrations/0002_workspace_single_module_context.py
 bloomerp/migrations/__init__.py
 bloomerp/model_fields/code_field.py
 bloomerp/model_fields/file_field.py
@@ -149,11 +150,9 @@ bloomerp/models/workspaces/workspace.py
 bloomerp/modules/__init__.py
 bloomerp/modules/automation.py
 bloomerp/modules/core.py
-bloomerp/modules/data.py
 bloomerp/modules/definition.py
 bloomerp/modules/misc.py
 bloomerp/modules/users.py
-bloomerp/modules/website.py
 bloomerp/sdk/base.py
 bloomerp/sdk/javascript.py
 bloomerp/sdk/python.py

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Bloomerp
-Version: 1.0.0.dev23
+Version: 1.0.0.dev24
 Summary: Bloomerp is an open-source Business Management Software framework that lets you create fully functional business management applications just by defining your Django database models.
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/bloomerp/components/global_search.py

@@ -164,11 +164,11 @@ def _collect_object_results(
             truncated = True
             matching_objects = matching_objects[:remaining_slots]
 
-        modules = module_registry.get_modules_for_model(model)
+        module = module_registry.get_module_for_model(model)
         results.append(
             {
                 "model_label": model._meta.verbose_name_plural.title(),
-                "module_labels": [module.name for module in modules] if modules else [],
+                "module_labels": [item.name for item in module_registry.get_lineage(module.full_id or module.id)] if module else [],
                 "objects": matching_objects,
             }
         )
@@ -388,7 +388,7 @@ def global_search(request: HttpRequest) -> HttpResponse:
                         context["slash_error"] = "Module not found."
                     else:
                         context["search_scope"] = {"module": module.name}
-                        models = module_registry.get_models_for_module(module.id)
+                        models = module_registry.get_models_for_module(module.id, include_descendants=True)
                         context["object_results"], truncated = _collect_object_results(
                             request,
                             permission_manager,
@@ -416,7 +416,7 @@ def global_search(request: HttpRequest) -> HttpResponse:
                             models = [
                                 model
                                 for model in models
-                                if model in module_registry.get_models_for_module(module.id)
+                                if model in module_registry.get_models_for_module(module.id, include_descendants=True)
                             ]
                             context["search_scope"] = {
                                 "module": module.name,

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/bloomerp/config/definition.py

@@ -74,10 +74,10 @@ class BloomerpConfig(BaseModel):
     """
 
     auto_generate_api_endpoints : bool = True
+    require_staff_for_access: bool = True
 
     vite_dev_server_url : Optional[str] = 'http://localhost:5173'
 
     auth: BloomerpAuthSettings = Field(default_factory=BloomerpAuthSettings)
     
 
-

bloomerp-1.0.0.dev24/bloomerp/migrations/0002_workspace_single_module_context.py

@@ -0,0 +1,29 @@
+# Generated by Codex on 2026-04-21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bloomerp", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.RemoveConstraint(
+            model_name="workspace",
+            name="unique_default_workspace_per_user_module_context",
+        ),
+        migrations.RemoveField(
+            model_name="workspace",
+            name="sub_module_id",
+        ),
+        migrations.AddConstraint(
+            model_name="workspace",
+            constraint=models.UniqueConstraint(
+                fields=("user", "module_id"),
+                condition=models.Q(("is_default", True)),
+                name="unique_default_workspace_per_user_module_context",
+            ),
+        ),
+    ]

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/bloomerp/models/definition.py

@@ -1,8 +1,9 @@
-from typing import Literal, Optional
+import inspect
+from typing import Any, Literal, Optional
 from bloomerp.config.definition import BloomerpConfig
 from bloomerp.models.base_bloomerp_model import FieldLayout
 from bloomerp.field_types import Lookup
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
 from django.conf import settings
 
 class ApiFilterRule(BaseModel):
@@ -235,7 +236,7 @@ class BloomerpModelConfig(BaseModel):
     Used to define certain bloomerp related meta data on a model. 
 
     Settings are:
-        - modules: a list of modules to which this model belongs.
+        - module: the canonical module to which this model belongs.
         - layout: a layout object defining how the default CRUD layout for users is.
 
     Usage
@@ -249,7 +250,7 @@ class BloomerpModelConfig(BaseModel):
     ``` 
     """
 
-    modules: Optional[list[str]] = None
+    module: str | type | None = None
 
     layout: Optional[FieldLayout] = None
 
@@ -259,6 +260,34 @@ class BloomerpModelConfig(BaseModel):
 
     api_settings: Optional[ApiSettings] = None
 
+    @field_validator("module", mode="before")
+    @classmethod
+    def normalize_module(cls, value: Any) -> str | None:
+        if value in (None, ""):
+            return None
+
+        if isinstance(value, str):
+            return value
+
+        try:
+            from bloomerp.modules.definition import BloomerpModule, ModuleConfig
+        except Exception:
+            return value
+
+        if isinstance(value, ModuleConfig):
+            return value.full_id or value.id
+
+        if inspect.isclass(value):
+            if issubclass(value, ModuleConfig):
+                module = value()
+                return module.full_id or module.id
+
+            if issubclass(value, BloomerpModule):
+                module = value.to_config()
+                return module.full_id or module.id
+
+        return value
+
     def get_public_access_rules(self, action: str) -> list[PublicAccessRule]:
         if self.api_settings is None:
             return []

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/bloomerp/models/project_management/todo.py

@@ -8,6 +8,7 @@ from django.contrib.contenttypes.fields import GenericForeignKey
 from django.core.exceptions import ValidationError
 
 from bloomerp.models.base_bloomerp_model import FieldLayout, LayoutItem, LayoutRow
+from bloomerp.models.definition import BloomerpModelConfig
 
 class TodoPriority(models.TextChoices):
     URGENT = ('urgent', 'Urgent')
@@ -38,12 +39,9 @@ class Todo(BloomerpModel):
     """
     The todo model is for Bloomerp's internal project management module.
     """
-    class Meta(BloomerpModel.Meta):
-        managed = True
-        db_table = 'bloomerp_todo'
-
-    class Bloomerp:
-        field_layout = FieldLayout(
+    bloomerp_config = BloomerpModelConfig(
+        module="misc",
+        layout=FieldLayout(
             rows=[
                 LayoutRow(
                     title="Details",
@@ -55,8 +53,8 @@ class Todo(BloomerpModel):
                         LayoutItem(id="priority", colspan=1),
                         LayoutItem(id="assigned_to", colspan=1),
                         LayoutItem(id="assigned_to", colspan=1),
-                        LayoutItem(id="content", colspan=4)
-                    ]
+                        LayoutItem(id="content", colspan=4),
+                    ],
                 ),
                 LayoutRow(
                     title="Users",
@@ -64,10 +62,15 @@ class Todo(BloomerpModel):
                     items=[
                         LayoutItem(id="requested_by"),
                         LayoutItem(id="requested_by"),
-                    ]
-                )
+                    ],
+                ),
             ]
-        )
+        ),
+    )
+
+    class Meta(BloomerpModel.Meta):
+        managed = True
+        db_table = 'bloomerp_todo'
 
     avatar = None
     allow_string_search = False # Do not allow string search for todos (we dont want to-do's to be searchable in the search bar)
@@ -174,4 +177,4 @@ class Todo(BloomerpModel):
 
         return super().clean()
 
-    
+    

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/bloomerp/models/users/user.py

@@ -16,6 +16,7 @@ from bloomerp.models.workspaces.sidebar_item import Sidebar
 
 
 USER_CONFIG = BloomerpModelConfig(
+    module="users",
     layout=FieldLayout()
 )
 
@@ -32,9 +33,6 @@ class AbstractBloomerpUser(
     string_search_fields = ['first_name+last_name', 'username']
     allow_string_search = True
 
-    class Bloomerp:
-        modules = ["users"]
-    
     # ------------------------------------------------
     # User Preferences
     # ------------------------------------------------
@@ -125,6 +123,8 @@ class AbstractBloomerpUser(
         )
     
 class User(AbstractBloomerpUser):
+    bloomerp_config = USER_CONFIG
+
     class Meta(BloomerpModel.Meta):
         db_table = "auth_user"
         swappable = "AUTH_USER_MODEL"

{bloomerp-1.0.0.dev23 → bloomerp-1.0.0.dev24}/bloomerp/models/workspaces/workspace.py

@@ -11,7 +11,7 @@ class Workspace(AbsoluteUrlModelMixin, models.Model):
         db_table = 'bloomerp_workspace'
         constraints = [
             models.UniqueConstraint(
-                fields=["user", "module_id", "sub_module_id"],
+                fields=["user", "module_id"],
                 condition=models.Q(is_default=True),
                 name="unique_default_workspace_per_user_module_context",
             ),
@@ -25,10 +25,6 @@ class Workspace(AbsoluteUrlModelMixin, models.Model):
         settings.AUTH_USER_MODEL, 
         on_delete=models.CASCADE
         )
-    sub_module_id = models.CharField(
-        max_length=255, 
-        default=""
-        )
     module_id = models.CharField(
         max_length=255, 
         default=""
@@ -47,22 +43,20 @@ class Workspace(AbsoluteUrlModelMixin, models.Model):
         return self.name
 
     @classmethod
-    def get_default_for_user(cls, user, module_id: str = "", sub_module_id: str = ""):
+    def get_default_for_user(cls, user, module_id: str = ""):
         return cls.objects.filter(
             user=user,
             module_id=module_id,
-            sub_module_id=sub_module_id,
             is_default=True,
         ).order_by("pk").first()
 
     @classmethod
-    def get_or_create_for_user(cls, user, module_id: str = "", sub_module_id: str = ""):
+    def get_or_create_for_user(cls, user, module_id: str = ""):
         from bloomerp.services.sectioned_layout_services import get_default_workspace_layout, layout_has_items
 
         workspace = cls.get_default_for_user(
             user=user,
             module_id=module_id,
-            sub_module_id=sub_module_id,
         )
         if workspace:
             if not layout_has_items(workspace.layout):
@@ -73,7 +67,6 @@ class Workspace(AbsoluteUrlModelMixin, models.Model):
             name=str(_("Default")),
             user=user,
             module_id=module_id,
-            sub_module_id=sub_module_id,
             layout=get_default_workspace_layout().model_dump(),
             is_default=True,
         )

bloomerp-1.0.0.dev24/bloomerp/modules/automation.py

@@ -0,0 +1,10 @@
+from .definition import BloomerpModule
+
+class AutomationModule(BloomerpModule):
+    id = "automation"
+    code = "automation"
+    icon = "fa-solid fa-robot"
+    name = "Automation"
+    description = "With automation, streamline and optimize your business processes by creating automated workflows."
+
+  

bloomerp-1.0.0.dev24/bloomerp/modules/core.py

@@ -0,0 +1,10 @@
+from .definition import BloomerpModule
+
+class CoreModule(BloomerpModule):
+    id = "core"
+    code = "core"
+    icon = "fa-solid fa-cogs"
+    name = "Core"
+    description = "Core functionalities and features of the ERP system."
+
+  

bloomerp-1.0.0.dev24/bloomerp/modules/definition.py

@@ -0,0 +1,327 @@
+from __future__ import annotations
+
+import importlib
+import inspect
+import logging
+import pkgutil
+from typing import Any
+
+from django import apps
+from django.db.models import Model
+from pydantic import BaseModel, Field
+
+from bloomerp.models.base_bloomerp_model import FieldLayout
+from bloomerp.models.definition import BloomerpModelConfig
+
+logger = logging.getLogger(__name__)
+
+
+class BaseConfig(BaseModel):
+    id: str
+    name: str
+    description: str | None = None
+    enabled: bool = True
+
+
+class FieldConfig(BaseConfig):
+    type: str
+    options: dict | None = None
+    validators: list[str] = Field(default_factory=list)
+
+
+class PermissionConfig(BaseModel):
+    id: str
+    name: str
+
+
+class ModelConfig(BaseConfig):
+    name_plural: str | None = None
+    fields: list[FieldConfig] = Field(default_factory=list)
+    custom_permissions: list[PermissionConfig] = Field(default_factory=list)
+    string_representation: str | None = None
+    field_layout: FieldLayout | None = None
+
+
+class ModuleConfig(BaseConfig):
+    code: str 
+    icon: str = "fa-solid fa-folder"
+    parent_module_id: str | None = None
+    visible: bool = True
+    full_id: str | None = None
+    route_path: str | None = None
+    root_module_id: str | None = None
+    depth: int = 0
+
+
+class BloomerpModule:
+    """Django-style authoring surface for Python module definitions."""
+
+    id: str | None = None
+    name: str | None = None
+    code: str | None = None
+    description: str | None = None
+    enabled: bool = True
+    icon: str = "fa-solid fa-folder"
+    parent_module_id: str | None = None
+    parent: str | None = None
+    visible: bool = True
+
+    @classmethod
+    def to_config(cls) -> ModuleConfig:
+        data = {
+            "id": cls.id,
+            "name": cls.name,
+            "description": cls.description,
+            "enabled": cls.enabled,
+            "icon": cls.icon,
+            "visible": cls.visible,
+        }
+
+        parent_module_id = cls.parent_module_id or cls.parent
+        if parent_module_id is not None:
+            data["parent_module_id"] = parent_module_id
+
+        data["code"] = cls.code or (cls.id.upper() if cls.id else None)
+        return ModuleConfig(**data)
+
+
+class ModuleRegistry:
+    def __init__(self):
+        self.items: dict[str, ModuleConfig] = {}
+        self._module_models: dict[str, dict[str, type[Model]]] = {}
+
+    def register(self, module: ModuleConfig) -> None:
+        module_key = module.full_id or module.id
+        if module_key in self.items:
+            logger.warning("Module with ID '%s' already exists. Overwriting.", module_key)
+        self.items[module_key] = module
+
+    def get(self, module_id: str | None) -> ModuleConfig | None:
+        if not module_id:
+            return None
+        return self.items.get(module_id)
+
+    def get_all(self) -> dict[str, ModuleConfig]:
+        return self.items.copy()
+
+    def get_enabled(self) -> dict[str, ModuleConfig]:
+        return {
+            module_id: module
+            for module_id, module in self.items.items()
+            if module.enabled
+        }
+
+    def get_root_modules(self) -> list[ModuleConfig]:
+        return [
+            module
+            for module in self.items.values()
+            if module.parent_module_id is None
+        ]
+
+    def get_children(self, module_id: str | None) -> list[ModuleConfig]:
+        if module_id is None:
+            return self.get_root_modules()
+        return [
+            module
+            for module in self.items.values()
+            if module.parent_module_id == module_id
+        ]
+
+    def get_ancestors(self, module_id: str | None) -> list[ModuleConfig]:
+        ancestors: list[ModuleConfig] = []
+        current = self.get(module_id)
+        seen: set[str] = set()
+        while current and current.parent_module_id:
+            if current.parent_module_id in seen:
+                logger.warning("Detected circular module ancestry while resolving '%s'.", module_id)
+                break
+            seen.add(current.parent_module_id)
+            parent = self.get(current.parent_module_id)
+            if not parent:
+                break
+            ancestors.append(parent)
+            current = parent
+        ancestors.reverse()
+        return ancestors
+
+    def get_lineage(self, module_id: str | None) -> list[ModuleConfig]:
+        module = self.get(module_id)
+        if not module:
+            return []
+        return [*self.get_ancestors(module_id), module]
+
+    def get_root(self, module_id: str | None) -> ModuleConfig | None:
+        lineage = self.get_lineage(module_id)
+        if not lineage:
+            return None
+        return lineage[0]
+
+    def get_models_for_module(self, module_id: str, include_descendants: bool = False) -> list[type[Model]]:
+        module_ids = {module_id}
+        if include_descendants:
+            module_ids.update(self._collect_descendant_ids(module_id))
+
+        models: dict[str, type[Model]] = {}
+        for current_id in module_ids:
+            for model_key, model in self._module_models.get(current_id, {}).items():
+                models.setdefault(model_key, model)
+        return list(models.values())
+
+    def get_module_for_model(self, model: type[Model]) -> ModuleConfig | None:
+        config = self._get_model_config(model)
+        if config and config.module:
+            return self.get(config.module)
+
+        model_key = model._meta.label_lower
+        for module_id, models in self._module_models.items():
+            if model_key in models:
+                return self.get(module_id)
+        return None
+
+    def refresh(self) -> None:
+        self.clear()
+
+        for app_config in apps.apps.get_app_configs():
+            try:
+                module_package = importlib.import_module(f"{app_config.name}.modules")
+            except ModuleNotFoundError:
+                continue
+
+            for _, attribute in inspect.getmembers(module_package, inspect.isclass):
+                self._register_module_class(attribute, source=app_config.name)
+
+            if not hasattr(module_package, "__path__"):
+                continue
+
+            for _, module_name, _ in pkgutil.iter_modules(module_package.__path__, module_package.__name__ + "."):
+                if module_name.endswith(".definition"):
+                    continue
+                try:
+                    imported_module = importlib.import_module(module_name)
+                except Exception as exc:
+                    logger.error("Error importing module '%s': %s", module_name, exc)
+                    continue
+
+                for _, attribute in inspect.getmembers(imported_module, inspect.isclass):
+                    self._register_module_class(attribute, source=module_name)
+
+        try:
+            from bloomerp_modules.utils.reader import scan_modules_directory
+        except Exception:
+            scan_modules_directory = None
+
+        if scan_modules_directory is not None:
+            try:
+                for module in scan_modules_directory():
+                    self.register(module)
+            except Exception as exc:
+                logger.error("Error loading YAML module definitions: %s", exc)
+
+        self._rebuild_hierarchy_metadata()
+        self._register_models_from_apps()
+
+    def clear(self) -> None:
+        self.items.clear()
+        self._module_models.clear()
+
+    def __len__(self) -> int:
+        return len(self.items)
+
+    def __contains__(self, module_id: str) -> bool:
+        return module_id in self.items
+
+    def _register_models_from_apps(self) -> None:
+        self._module_models.clear()
+        for model in apps.apps.get_models():
+            config = self._get_model_config(model)
+            module_id = None
+            if config and config.module:
+                module_id = config.module
+            if not module_id:
+                module_id = "misc"
+
+            module = self.get(module_id)
+            if module is None:
+                module = ModuleConfig(
+                    id=module_id.split(".")[-1],
+                    name=module_id.split(".")[-1].replace("_", " ").replace("-", " ").title(),
+                    code=module_id.split(".")[-1],
+                    full_id=module_id,
+                )
+                self.register(module)
+                self._rebuild_hierarchy_metadata()
+
+            self._add_model_to_module(module, model)
+
+    def _get_model_config(self, model: type[Model]) -> BloomerpModelConfig | None:
+        config = getattr(model, "bloomerp_config", None)
+        if isinstance(config, BloomerpModelConfig):
+            return config
+        return None
+
+    def _register_module_class(self, attribute: type, source: str) -> None:
+        if attribute in {ModuleConfig, BloomerpModule}:
+            return
+
+        try:
+            if issubclass(attribute, ModuleConfig):
+                self.register(attribute())
+                return
+
+            if issubclass(attribute, BloomerpModule):
+                self.register(attribute.to_config())
+                return
+        except TypeError:
+            return
+        except Exception as exc:
+            logger.error(
+                "Error instantiating module '%s' in '%s': %s",
+                attribute.__name__,
+                source,
+                exc,
+            )
+
+    def _add_model_to_module(self, module: ModuleConfig, model: type[Model]) -> None:
+        module_key = module.full_id or module.id
+        module_models = self._module_models.setdefault(module_key, {})
+        module_models.setdefault(model._meta.label_lower, model)
+
+    def _collect_descendant_ids(self, module_id: str) -> set[str]:
+        descendants: set[str] = set()
+        pending = [module_id]
+        while pending:
+            current_id = pending.pop()
+            for child in self.get_children(current_id):
+                child_id = child.full_id or child.id
+                if child_id in descendants:
+                    continue
+                descendants.add(child_id)
+                pending.append(child_id)
+        return descendants
+
+    def _rebuild_hierarchy_metadata(self) -> None:
+        for module in self.items.values():
+            module.full_id = module.full_id or (
+                f"{module.parent_module_id}.{module.id}" if module.parent_module_id else module.id
+            )
+
+        for module in self.items.values():
+            lineage = self.get_lineage(module.full_id or module.id)
+            if not lineage:
+                module.route_path = module.id.lower()
+                module.root_module_id = module.full_id or module.id
+                module.depth = 0
+                continue
+
+            module.route_path = "/".join(item.id.lower() for item in lineage)
+            module.root_module_id = lineage[0].full_id or lineage[0].id
+            module.depth = len(lineage) - 1
+
+        rebuilt_items: dict[str, ModuleConfig] = {}
+        for module in self.items.values():
+            module_key = module.full_id or module.id
+            rebuilt_items[module_key] = module
+        self.items = rebuilt_items
+
+
+module_registry = ModuleRegistry()

bloomerp-1.0.0.dev24/bloomerp/modules/misc.py

@@ -0,0 +1,9 @@
+from .definition import BloomerpModule
+
+class MiscModule(BloomerpModule):
+    id = "misc"
+    code = "misc"
+    icon = "fa-solid fa-ellipsis-h"
+    name = "Miscellaneous"
+    description = "A collection of miscellaneous features and tools that don't fit into other specific modules."
+    

bloomerp-1.0.0.dev24/bloomerp/modules/users.py

@@ -0,0 +1,9 @@
+from .definition import BloomerpModule
+
+class UsersModule(BloomerpModule):
+    id = "users"
+    code = "users"
+    icon = "fa-solid fa-users"
+    name = "Users"
+    description = "Manage users, roles, and permissions within the ERP system."
+