Bloomerp 1.0.0.dev36__tar.gz → 1.0.0.dev38__tar.gz

{bloomerp-1.0.0.dev36 → bloomerp-1.0.0.dev38}/Bloomerp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Bloomerp
-Version: 1.0.0.dev36
+Version: 1.0.0.dev38
 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.dev36 → bloomerp-1.0.0.dev38}/Bloomerp.egg-info/SOURCES.txt

@@ -10,7 +10,6 @@ bloomerp/__init__.py
 bloomerp/admin.py
 bloomerp/apps.py
 bloomerp/auth.py
-bloomerp/cli.py
 bloomerp/consumers.py
 bloomerp/context_processors.py
 bloomerp/field_types.py
@@ -31,6 +30,24 @@ bloomerp/automation/triggers/base.py
 bloomerp/automation/triggers/human_trigger.py
 bloomerp/automation/triggers/object_crud_trigger.py
 bloomerp/automation/triggers/webhook_trigger.py
+bloomerp/cli/__init__.py
+bloomerp/cli/main.py
+bloomerp/cli/template_project/manage.py
+bloomerp/cli/template_project/<app-name>/__init__.py
+bloomerp/cli/template_project/<app-name>/admin.py
+bloomerp/cli/template_project/<app-name>/apps.py
+bloomerp/cli/template_project/<app-name>/migrations/__init__.py
+bloomerp/cli/template_project/<app-name>/models/__init__.py
+bloomerp/cli/template_project/<app-name>/models/sample.py
+bloomerp/cli/template_project/<app-name>/views/__init__.py
+bloomerp/cli/template_project/<app-name>/views/sample.py
+bloomerp/cli/template_project/config/__init__.py
+bloomerp/cli/template_project/config/asgi.py
+bloomerp/cli/template_project/config/urls.py
+bloomerp/cli/template_project/config/wsgi.py
+bloomerp/cli/template_project/config/settings/__init__.py
+bloomerp/cli/template_project/config/settings/base.py
+bloomerp/cli/template_project/config/settings/bloomerp.py
 bloomerp/components/bookmark.py
 bloomerp/components/comments.py
 bloomerp/components/detail_tabs_folder_modal.py

bloomerp-1.0.0.dev38/Bloomerp.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bloomerp = bloomerp.cli.main:main

{bloomerp-1.0.0.dev36 → bloomerp-1.0.0.dev38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Bloomerp
-Version: 1.0.0.dev36
+Version: 1.0.0.dev38
 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.dev38/bloomerp/cli/__init__.py

@@ -0,0 +1,3 @@
+from .main import main
+
+__all__ = ["main"]

bloomerp-1.0.0.dev38/bloomerp/cli/main.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+import keyword
+import re
+from pathlib import Path
+
+import click
+
+
+TEMPLATE_DIR = Path(__file__).resolve().parent / "template_project"
+
+
+def _slugify_package_name(value: str) -> str:
+    slug = re.sub(r"[^a-zA-Z0-9_]+", "_", value).strip("_").lower()
+    if not slug:
+        raise click.ClickException("Project names must contain at least one letter or number.")
+    if slug[0].isdigit():
+        slug = f"project_{slug}"
+    if keyword.iskeyword(slug):
+        slug = f"{slug}_project"
+    return slug
+
+
+def _distribution_name(value: str) -> str:
+    slug = re.sub(r"[^a-zA-Z0-9-]+", "-", value).strip("-").lower()
+    if not slug:
+        raise click.ClickException("Project names must contain at least one letter or number.")
+    return slug
+
+
+def _render_template(text: str, replacements: dict[str, str]) -> str:
+    for placeholder, value in replacements.items():
+        text = text.replace(placeholder, value)
+    return text
+
+
+def _copy_template_project(target_dir: Path, replacements: dict[str, str]) -> None:
+    for source_path in sorted(TEMPLATE_DIR.rglob("*")):
+        if "__pycache__" in source_path.parts or source_path.suffix == ".pyc":
+            continue
+        relative_path = source_path.relative_to(TEMPLATE_DIR)
+        rendered_relative_path = Path(
+            _render_template(relative_path.as_posix(), replacements)
+        )
+        destination_path = target_dir / rendered_relative_path
+
+        if source_path.is_dir():
+            destination_path.mkdir(parents=True, exist_ok=True)
+            continue
+
+        destination_path.parent.mkdir(parents=True, exist_ok=True)
+        contents = source_path.read_text(encoding="utf-8")
+        destination_path.write_text(
+            _render_template(contents, replacements),
+            encoding="utf-8",
+        )
+
+
+@click.group()
+def main() -> None:
+    """Bloomerp command line tools."""
+
+
+@main.command()
+@click.argument("directory", required=False)
+def init(directory: str | None) -> None:
+    """Create a minimal Django project configured for Bloomerp."""
+
+    target_name = directory or click.prompt("Project directory", default="my-bloomerp-project")
+    target_dir = Path(target_name).expanduser().resolve()
+
+    default_project_name = target_dir.name
+    project_name = click.prompt("Project name", default=default_project_name)
+    app_name = click.prompt("Main Django app", default="core", show_default=True)
+    app_name = _slugify_package_name(app_name)
+
+    if target_dir.exists() and any(target_dir.iterdir()):
+        raise click.ClickException(f"Target directory already exists and is not empty: {target_dir}")
+
+    replacements = {
+        "__PROJECT_NAME__": project_name,
+        "__APP_NAME__": app_name,
+        "__APP_CLASS_NAME__": "".join(part.capitalize() for part in app_name.split("_")) + "Config",
+        "__DISTRIBUTION_NAME__": _distribution_name(project_name),
+        "<app-name>": app_name,
+    }
+
+    _copy_template_project(target_dir, replacements)
+
+    click.echo(f"Created Bloomerp project at {target_dir}")
+    click.echo("")
+    click.echo("Next steps:")
+    click.echo(f"  cd {target_dir}")
+    click.echo("  python -m venv .venv")
+    click.echo("  source .venv/bin/activate")
+    click.echo("  pip install -e .")
+    click.echo("  python manage.py migrate")
+    click.echo("  python manage.py createsuperuser")
+    click.echo("  python manage.py save_application_fields")
+    click.echo("  python manage.py runserver")
+
+
+if __name__ == "__main__":
+    main()

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/<app-name>/admin.py

@@ -0,0 +1 @@
+from django.contrib import admin

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/<app-name>/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class __APP_CLASS_NAME__(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "__APP_NAME__"

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/<app-name>/migrations/__init__.py

@@ -0,0 +1 @@
+

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/<app-name>/models/sample.py

@@ -0,0 +1,10 @@
+from bloomerp.models import BloomerpModel
+from bloomerp.models.definition import (
+    BloomerpModelConfig,
+    ApiSettings
+)
+
+class SampleModel(BloomerpModel):
+    bloomerp_config = BloomerpModelConfig(
+        
+    )

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/<app-name>/views/sample.py

@@ -0,0 +1,17 @@
+from bloomerp.router import router
+from bloomerp.views.detail.base_detail import BaseBloomerpDetailView
+
+from ..models.sample import SampleModel
+
+@router.register("/function-based-view/")
+def sample_function_based_view(request):
+    return {"message": "Hello from the function-based view!"}
+
+
+@router.register(
+    path="/class-based-view/",
+    route_type="detail",
+    models=[SampleModel]
+    )
+class SampleClassBasedView(BaseBloomerpDetailView):
+    template_name = "sample_detail_view.html"

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/config/__init__.py

@@ -0,0 +1 @@
+

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/config/asgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.bloomerp")
+
+application = get_asgi_application()

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/config/settings/base.py

@@ -0,0 +1,67 @@
+from pathlib import Path
+
+
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
+
+SECRET_KEY = "change-me"
+DEBUG = True
+ALLOWED_HOSTS = []
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "__APP_NAME__",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "config.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "config.wsgi.application"
+ASGI_APPLICATION = "config.asgi.application"
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+AUTH_PASSWORD_VALIDATORS = []
+
+LANGUAGE_CODE = "en-us"
+TIME_ZONE = "UTC"
+USE_I18N = True
+USE_TZ = True
+
+STATIC_URL = "static/"
+STATIC_ROOT = BASE_DIR / "staticfiles"
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/config/settings/bloomerp.py

@@ -0,0 +1,29 @@
+from .base import *
+
+from bloomerp.config.settings import (
+    BLOOMERP_APPS,
+    BLOOMERP_AUTHENTICATION_BACKENDS,
+    BLOOMERP_MIDDLEWARE,
+    BLOOMERP_SITE_ID,
+    BLOOMERP_USER_MODEL,
+)
+from bloomerp.config import BloomerpConfig
+
+INSTALLED_APPS += BLOOMERP_APPS
+MIDDLEWARE += BLOOMERP_MIDDLEWARE
+AUTHENTICATION_BACKENDS = BLOOMERP_AUTHENTICATION_BACKENDS
+AUTH_USER_MODEL = BLOOMERP_USER_MODEL
+SITE_ID = BLOOMERP_SITE_ID
+
+CRISPY_ALLOWED_TEMPLATE_PACKS = "tailwind"
+CRISPY_TEMPLATE_PACK = "tailwind"
+
+BLOOMERP_CONFIG = BloomerpConfig()
+
+BLOOMERP_SETTINGS = {
+    "globals": {
+        "organization_name": "__PROJECT_NAME__",
+    },
+    "BASE_URL": "",
+    "ROUTERS": [],
+}

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/config/urls.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from django.urls import include, path
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path("", include("bloomerp.urls")),
+]

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/config/wsgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.bloomerp")
+
+application = get_wsgi_application()

bloomerp-1.0.0.dev38/bloomerp/cli/template_project/manage.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.bloomerp")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

{bloomerp-1.0.0.dev36 → bloomerp-1.0.0.dev38}/bloomerp/components/detail_tabs_preference.py

@@ -7,6 +7,7 @@ from django.shortcuts import get_object_or_404
 from bloomerp.models.users.user_detail_view_preference import UserDetailViewPreference
 from bloomerp.router import router
 from bloomerp.services.detail_view_services import (
+    build_default_tab_state_from_tabs,
     get_ordered_tab_keys_from_state,
     get_router_detail_tabs,
     save_detail_tab_state,
@@ -38,14 +39,18 @@ def detail_tabs_preference(request: HttpRequest) -> HttpResponse:
 
     state_raw = request.POST.get('state')
     if not state_raw:
-        return HttpResponse('Missing state', status=400)
+        state = build_default_tab_state_from_tabs(available_tabs)
+    else:
+        try:
+            state = json.loads(state_raw)
+        except json.JSONDecodeError:
+            state = build_default_tab_state_from_tabs(available_tabs)
 
     try:
-        state = json.loads(state_raw)
-    except json.JSONDecodeError:
-        return HttpResponse('Invalid state payload', status=400)
-
-    requested_keys = get_ordered_tab_keys_from_state(state)
+        requested_keys = get_ordered_tab_keys_from_state(state)
+    except ValueError:
+        state = build_default_tab_state_from_tabs(available_tabs)
+        requested_keys = get_ordered_tab_keys_from_state(state)
 
     existing_keys = {str(tab.get('key')) for tab in available_tabs if tab.get('key')}
     for key in requested_keys:

{bloomerp-1.0.0.dev36 → bloomerp-1.0.0.dev38}/bloomerp/components/global_search.py

@@ -34,11 +34,17 @@ from django.contrib.auth import get_user_model
 from django.urls import reverse
 from django.urls import NoReverseMatch
 
+from bloomerp.models.application_field import ApplicationField
+from bloomerp.models.base_bloomerp_model import BloomerpModel
+from bloomerp.models.definition import BloomerpModelConfig
 from bloomerp.router import router
 from bloomerp.modules.definition import module_registry
-from bloomerp.services.permission_services import UserPermissionManager
+from bloomerp.services.permission_services import UserPermissionManager, create_permission_str
 from bloomerp.utils.models import string_search_queryset
 
+from django.contrib.auth.models import Permission
+from django.contrib.sessions.models import Session
+
 # -------------------------------
 # Helper functions
 # -------------------------------
@@ -108,6 +114,27 @@ def _resolve_models_by_name(model_key: str) -> list:
                 matched.append(model)
     return matched
 
+def _ignore_model(model) -> bool:
+    """Determines whether a model should be ignored in the search results."""
+    internal_models = [
+        ContentType,
+        ApplicationField,
+        Permission,
+        Session
+    ]
+
+    if not model or model in internal_models:
+        return True
+    if getattr(model._meta, "swapped", None):
+        return True
+    
+    if hasattr(model, "bloomerp_config") and isinstance(getattr(model, "bloomerp_config"), BloomerpModelConfig):
+        config : BloomerpModelConfig = getattr(model, "bloomerp_config")
+        if config.is_internal:
+            return True
+
+    return False
+
 def _collect_object_results(
     request: HttpRequest,
     permission_manager: UserPermissionManager,
@@ -116,6 +143,19 @@ def _collect_object_results(
     per_model_limit: int,
     total_limit: int,
 ) -> tuple[list, bool]:
+    """Collects the results for objects in a way that is accesible to the template
+
+    Args:
+        request (HttpRequest): the request object
+        permission_manager (UserPermissionManager): the permissions manager
+        models (list): the list of models
+        search_value (str): the search value
+        per_model_limit (int): limit per model
+        total_limit (int): total limit
+
+    Returns:
+        tuple[list, bool]: a tuple containing the list of results and a boolean indicating if the results were truncated
+    """
     results = []
     total_results = 0
     truncated = False
@@ -124,26 +164,11 @@ def _collect_object_results(
         return results, truncated
 
     for model in models:
-        if not model or model == ContentType:
-            continue
-        if getattr(model._meta, "swapped", None):
-            continue
-
-        content_type = ContentType.objects.get_for_model(model)
-        row_policies_exist = permission_manager.get_row_policies().filter(
-            content_type=content_type
-        ).exists()
-
-        permission_name = f"{model._meta.app_label}.view_{model._meta.model_name}"
-
-        if request.user.is_superuser:
-            base_qs = model.objects.all()
-        elif row_policies_exist:
-            base_qs = permission_manager.get_queryset(model, f"view_{model._meta.model_name}")
-        elif request.user.has_perm(permission_name):
-            base_qs = model.objects.all()
-        else:
+        if _ignore_model(model):
             continue
+        
+        # Get the objects
+        base_qs = permission_manager.get_queryset(model, create_permission_str(model, "view"))
 
         remaining_slots = total_limit - total_results
         if remaining_slots <= 0:
@@ -169,7 +194,11 @@ def _collect_object_results(
             {
                 "model_label": model._meta.verbose_name_plural.title(),
                 "module_labels": [item.name for item in module_registry.get_lineage(module.full_id or module.id)] if module else [],
-                "objects": matching_objects,
+                "objects": matching_objects, 
+                "detail_routes" : router.filter(
+                    route_type="detail",
+                    model=model,
+                )
             }
         )
 
@@ -180,7 +209,6 @@ def _collect_object_results(
 
     return results, truncated
 
-
 def _get_accessible_models(
     request: HttpRequest,
     permission_manager: UserPermissionManager,
@@ -263,6 +291,12 @@ def global_search(request: HttpRequest) -> HttpResponse:
                 for route in router.get_routes():
                     if route.name.startswith("components_"):
                         continue
+                    if route.path.startswith("/api/"):
+                        continue
+                    
+                    # We don't want to include routes that require arguments in the global search, as they cannot be directly navigated to without additional input. This is because the global search is designed for quick navigation, and including routes with required arguments could lead to confusion or dead ends in the search results.
+                    if route.nr_of_args() > 0:
+                        continue
 
                     route_name = route.name or ""
                     route_desc = route.description or ""
@@ -455,6 +489,7 @@ def global_search(request: HttpRequest) -> HttpResponse:
                     TOTAL_LIMIT,
                 )
                 context["results_truncated"] = context["results_truncated"] or truncated
+                
 
     return render(request, "components/global_search.html", context)
     

{bloomerp-1.0.0.dev36 → bloomerp-1.0.0.dev38}/bloomerp/config/definition.py

@@ -1,7 +1,10 @@
 from typing import Literal, Optional
-
 from pydantic import BaseModel, Field
 
+INTERNAL_MODELS = [
+    
+]
+
 
 class SocialProviderSettings(BaseModel):
     provider: str

{bloomerp-1.0.0.dev36 → bloomerp-1.0.0.dev38}/bloomerp/field_types.py

@@ -347,6 +347,15 @@ ON_DELETE_FIELD_OPTION = FieldOption(
     choices=["CASCADE", "PROTECT", "SET_NULL", "SET_DEFAULT", "DO_NOTHING"],
 )
 
+CHOICES_FIELD_OPTION = FieldOption(
+    "choices",
+    "Choices",
+    "choices",
+    "Fixed options available for this field.",
+    required=True,
+    default_value=[],
+)
+
 COMMON_FIELD_OPTIONS = [
     VERBOSE_NAME_FIELD_OPTION,
     NULL_FIELD_OPTION,
@@ -362,6 +371,12 @@ COMMON_TEXT_FIELD_OPTIONS = [
     MAX_LENGTH_FIELD_OPTION,
 ]
 
+COMMON_CHOICE_FIELD_OPTIONS = [
+    *COMMON_FIELD_OPTIONS,
+    CHOICES_FIELD_OPTION,
+    MAX_LENGTH_FIELD_OPTION,
+]
+
 COMMON_RELATION_FIELD_OPTIONS = [
     TO_FIELD_OPTION,
     VERBOSE_NAME_FIELD_OPTION,
@@ -527,7 +542,7 @@ class FieldType(Enum):
         default_model_field_args={
             "max_length": 50,
         },
-        field_options=COMMON_TEXT_FIELD_OPTIONS,
+        field_options=COMMON_CHOICE_FIELD_OPTIONS,
     )
     
     TEXT_FIELD = FieldTypeDefinition(

{bloomerp-1.0.0.dev36 → bloomerp-1.0.0.dev38}/bloomerp/models/users/user_detail_view_preference.py

@@ -8,8 +8,8 @@ from bloomerp.services.sectioned_layout_services import normalize_layout_payload
 
 
 def get_default_tab_state() -> dict:
-    from bloomerp.services.detail_view_services import get_default_tab_state_v2
-    return get_default_tab_state_v2()
+    from bloomerp.services.detail_view_services import get_default_tab_state
+    return get_default_tab_state()
 
 class UserDetailViewPreference(models.Model):
     """
@@ -60,10 +60,15 @@ class UserDetailViewPreference(models.Model):
         )
         if qs.exists():
             preference = qs.first()
+            update_fields: list[str] = []
+
             if not preference.field_layout_obj.rows or not any(row.items for row in preference.field_layout_obj.rows):
                 from bloomerp.services.detail_view_services import get_default_layout
                 preference.field_layout = get_default_layout(content_type=content_type, user=user).model_dump()
-                preference.save(update_fields=["field_layout"])
+                update_fields.append("field_layout")
+
+            if update_fields:
+                preference.save(update_fields=update_fields)
             return preference
 
         return UserDetailViewPreference.create_default_for_user(user, content_type)
@@ -102,7 +107,10 @@ class UserDetailViewPreference(models.Model):
         from bloomerp.services.detail_view_services import normalize_detail_tab_state
         if not isinstance(self.tab_state, dict):
             return get_default_tab_state()
-        return normalize_detail_tab_state(self.tab_state)
+        try:
+            return normalize_detail_tab_state(self.tab_state)
+        except ValueError:
+            return get_default_tab_state()