smoothglue_django_core 1.3.0__tar.gz

smoothglue_django_core-1.3.0/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2020–2025, BrainGu LLC. All rights reserved.
+
+This software is part of SmoothGlue™, a proprietary product developed by BrainGu LLC.
+
+This software is proprietary and confidential. It may not be copied, modified, distributed,
+or used in any form except under a valid commercial license agreement with BrainGu.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+
+To inquire about licensing, contact: legal@braingu.com

smoothglue_django_core-1.3.0/NOTICE

@@ -0,0 +1,12 @@
+SmoothGlue™ GuC2 Backend Core
+Copyright 2020–2025 BrainGu, LLC (https://www.braingu.com)
+
+This product includes software developed by BrainGu, LLC as part of the SmoothGlue™ platform.
+
+This software is proprietary and may only be used under a license agreement with BrainGu.
+Unauthorized use, modification, or redistribution is prohibited.
+
+This software may include third-party components licensed under separate open source terms.
+See the dependencies section of pyproject.toml for details on third-party components.
+
+For licensing inquiries, contact: legal@braingu.com

smoothglue_django_core-1.3.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.3
+Name: smoothglue_django_core
+Version: 1.3.0
+Summary: Enhance your development with SmoothGlue™, providing a user-friendly gateway to interoperable microservices for effortlessly creating complex app behaviors.
+License: Proprietary
+Keywords: Interoperability,API Integration,Edge Computing,Application Framework,Data-Driven Development
+Author: BrainGu
+Author-email: smoothglue@braingu.com
+Maintainer: BrainGu
+Maintainer-email: info@braingu.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Dist: Django (>=4.2.0,<6.0.0)
+Requires-Dist: PyJWT (>=2.10.1,<3.0.0)
+Requires-Dist: adrf (>=0.1.9,<1.0.0)
+Requires-Dist: coverage[toml] (==7.9.2)
+Requires-Dist: django-cors-headers (>=4.6.0,<5.0.0)
+Requires-Dist: django-filter (>=25.1,<26.0)
+Requires-Dist: django-json-widget (>=2.0.1,<3.0.0)
+Requires-Dist: djangorestframework (>=3.15.2,<4.0.0)
+Requires-Dist: drf-spectacular (>=0.28.0,<1.0.0)
+Requires-Dist: pillow (>=11.1.0,<12.0.0)
+Requires-Dist: pytest (>=8.4.0)
+Project-URL: Homepage, https://braingu.com/solutions/smoothglue/
+Project-URL: Issues, https://braingu.com/support
+Description-Content-Type: text/markdown
+
+# SmoothGlue Django Core
+
+# Overview
+
+SmoothGlue Django Core provides a robust foundation for creating extendable and secure application features, optimized for highly regulated environments. This project includes reusable Django apps designed to streamline development for applications requiring stringent security and compliance measures.
+
+## Key Features
+
+- **Abstract Models:** Includes abstract models like `AuditModel` and `TimeAuditModel` for audit trail functionality in your models.
+- **Reusable Serializers:** A set of base serializers for consistent API development.
+- **Custom User Model:** Extensible user model adaptable to various authentication requirements.
+- **Environment-specific Configuration:** Designed for easy configuration in different environments (development, staging, production).
+
+## Installation
+
+### Prerequisites
+
+* Python 3.12+
+* Django 4.2+
+* Django REST Framework 3.15.2+
+
+
+### Install SmoothGlue Django Core From PyPI (Official Use)
+
+1. Use pip and the following command inside the Django project:
+
+   ```python
+   pip install smoothglue_django_core
+   ```
+
+2. Enable Smoothglue Django Core's apps in your settings.py:
+
+
+
+```bash
+INSTALLED_APPS = [
+    # ... other installed apps ...
+    'smoothglue.core',
+    'smoothglue.authentication',
+    'smoothglue.tracker',
+    # ... other installed apps ...
+]
+```
+
+3. **Database Migrations:**
+
+Run the migrations to create the necessary database tables:
+
+```bash
+python manage.py migrate
+```
+
+4. Run the development server to confirm the project continues to work.
+
+## API Usage
+
+This package exposes several API endpoints to manage users, organizations, and other related data.
+
+### Authentication
+This package uses JWT-based authentication. The JWT is decoded from the Authorization or Jwt header of the request. In a development environment, ENABLE_SINGLE_USER_MODE can be set to `True` to bypass JWT authentication and use a default "UnknownUser".
+
+### Endpoints
+
+#### Users
+- `GET /users/`: Retrieves a list of all users.
+
+- `POST /users/`: Creates a new user.
+
+- `GET /users/{id}/`: Retrieves a specific user by their ID.
+
+- `PUT /users/{id}/`: Updates a specific user.
+
+- `PATCH /users/{id}/`: Partially updates a user.
+
+- `DELETE /users/{id}/`: Deletes a user.
+
+#### Organizations
+
+- `GET /organizations/`: Retrieves a list of all organizations.
+
+- `POST /organizations/`: Creates a new organization.
+
+- `GET /organizations/{id}/`: Retrieves a specific organization by its ID.
+
+- `PUT /organizations/{id}/`: Updates an organization.
+
+- `PATCH /organizations/{id}/`: Partially updates an organization.
+
+- `DELETE /organizations/{id}/`: Deletes an organization.
+
+#### Organization Members
+
+- `GET /org-members/`: Retrieves a list of all organization members.
+
+#### Organization Categories
+
+- `GET /org-categories/`: Retrieves a list of all organization categories.
+
+- `POST /org-categories/`: Creates a new organization category.
+
+- `GET /org-categories/{id}/`: Retrieves a specific organization category by its ID.
+
+- `PUT /org-categories/{id}/`: Updates an organization category.
+
+- `PATCH /org-categories/{id}/`: Partially updates an organization category.
+
+- `DELETE /org-categories/{id}/`: Deletes an organization category.
+
+#### Active User
+
+- `GET /active_user/`: Retrieves the currently authenticated user's information.
+
+## License
+
+This project is licensed under a Proprietary License. See the [LICENSE](./LICENSE) file for more details.
+

smoothglue_django_core-1.3.0/README.md

@@ -0,0 +1,115 @@
+# SmoothGlue Django Core
+
+# Overview
+
+SmoothGlue Django Core provides a robust foundation for creating extendable and secure application features, optimized for highly regulated environments. This project includes reusable Django apps designed to streamline development for applications requiring stringent security and compliance measures.
+
+## Key Features
+
+- **Abstract Models:** Includes abstract models like `AuditModel` and `TimeAuditModel` for audit trail functionality in your models.
+- **Reusable Serializers:** A set of base serializers for consistent API development.
+- **Custom User Model:** Extensible user model adaptable to various authentication requirements.
+- **Environment-specific Configuration:** Designed for easy configuration in different environments (development, staging, production).
+
+## Installation
+
+### Prerequisites
+
+* Python 3.12+
+* Django 4.2+
+* Django REST Framework 3.15.2+
+
+
+### Install SmoothGlue Django Core From PyPI (Official Use)
+
+1. Use pip and the following command inside the Django project:
+
+   ```python
+   pip install smoothglue_django_core
+   ```
+
+2. Enable Smoothglue Django Core's apps in your settings.py:
+
+
+
+```bash
+INSTALLED_APPS = [
+    # ... other installed apps ...
+    'smoothglue.core',
+    'smoothglue.authentication',
+    'smoothglue.tracker',
+    # ... other installed apps ...
+]
+```
+
+3. **Database Migrations:**
+
+Run the migrations to create the necessary database tables:
+
+```bash
+python manage.py migrate
+```
+
+4. Run the development server to confirm the project continues to work.
+
+## API Usage
+
+This package exposes several API endpoints to manage users, organizations, and other related data.
+
+### Authentication
+This package uses JWT-based authentication. The JWT is decoded from the Authorization or Jwt header of the request. In a development environment, ENABLE_SINGLE_USER_MODE can be set to `True` to bypass JWT authentication and use a default "UnknownUser".
+
+### Endpoints
+
+#### Users
+- `GET /users/`: Retrieves a list of all users.
+
+- `POST /users/`: Creates a new user.
+
+- `GET /users/{id}/`: Retrieves a specific user by their ID.
+
+- `PUT /users/{id}/`: Updates a specific user.
+
+- `PATCH /users/{id}/`: Partially updates a user.
+
+- `DELETE /users/{id}/`: Deletes a user.
+
+#### Organizations
+
+- `GET /organizations/`: Retrieves a list of all organizations.
+
+- `POST /organizations/`: Creates a new organization.
+
+- `GET /organizations/{id}/`: Retrieves a specific organization by its ID.
+
+- `PUT /organizations/{id}/`: Updates an organization.
+
+- `PATCH /organizations/{id}/`: Partially updates an organization.
+
+- `DELETE /organizations/{id}/`: Deletes an organization.
+
+#### Organization Members
+
+- `GET /org-members/`: Retrieves a list of all organization members.
+
+#### Organization Categories
+
+- `GET /org-categories/`: Retrieves a list of all organization categories.
+
+- `POST /org-categories/`: Creates a new organization category.
+
+- `GET /org-categories/{id}/`: Retrieves a specific organization category by its ID.
+
+- `PUT /org-categories/{id}/`: Updates an organization category.
+
+- `PATCH /org-categories/{id}/`: Partially updates an organization category.
+
+- `DELETE /org-categories/{id}/`: Deletes an organization category.
+
+#### Active User
+
+- `GET /active_user/`: Retrieves the currently authenticated user's information.
+
+## License
+
+This project is licensed under a Proprietary License. See the [LICENSE](./LICENSE) file for more details.

smoothglue_django_core-1.3.0/pyproject.toml

@@ -0,0 +1,178 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[project]
+name = "smoothglue_django_core"
+version = "1.3.0"
+description = "Enhance your development with SmoothGlue™, providing a user-friendly gateway to interoperable microservices for effortlessly creating complex app behaviors."
+authors = [
+    {name = "BrainGu", email = "smoothglue@braingu.com"}
+]
+maintainers = [
+    {name = "BrainGu", email = "info@braingu.com"}
+]
+license = {text = "Proprietary"}
+readme = "README.md"
+requires-python = ">=3.12,<4.0"
+keywords = [
+    "Interoperability",
+    "API Integration",
+    "Edge Computing",
+    "Application Framework",
+    "Data-Driven Development"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Django :: 5.2",
+    "Framework :: Django",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent"
+]
+dependencies = [
+    "django-cors-headers>=4.6.0,<5.0.0",
+    "Django>=4.2.0,<6.0.0",
+    "djangorestframework>=3.15.2,<4.0.0",
+    "django-filter>=25.1,<26.0",
+    "django-json-widget>=2.0.1,<3.0.0",
+    "drf-spectacular>=0.28.0,<1.0.0",
+    "PyJWT>=2.10.1,<3.0.0",
+    "pillow>=11.1.0,<12.0.0",
+    "adrf>=0.1.9,<1.0.0",
+    "coverage[toml]==7.9.2",
+    "pytest>=8.4.0"
+]
+
+[project.urls]
+Homepage = "https://braingu.com/solutions/smoothglue/"
+Issues = "https://braingu.com/support"
+
+[project.scripts]
+pylint = "smoothglue.core.scripts.lint:_run_pylint"
+
+[tool.poetry]
+packages = [
+    { include = "smoothglue" },
+]
+name = "smoothglue_django_core"
+version = "1.3.0"
+description = "Enhance your development with SmoothGlue™, providing a user-friendly gateway to interoperable microservices for effortlessly creating complex app behaviors."
+authors = ["BrainGu"]
+
+[tool.poetry.dependencies]
+python = ">=3.12,<4.0"
+
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
+
+[tool.poetry.group.dev.dependencies]
+coverage = { extras = ["toml"], version = "^7.9.0" }
+pylint-django = "^2.6.1"
+flake8 = "^7.2.0"
+ipython = "^8.30.0"
+pre-commit = "^4.2.0"
+black = "^25.1.0"
+isort = "^5.13.2"
+pylint = "^3.3.7"
+pytest = "^8.4.0"
+pytest-django = "^4.9.0"
+pytest-asyncio = "^0.24.0"
+
+
+
+[tool.black]
+exclude = '''
+/(
+    .cache
+    | venv
+    | smoothglue/authentication/migrations
+)/
+'''
+
+[tool.pylint.main]
+recursive = true
+fail-under = 10
+max-attributes = 15
+ignore-paths = [
+    "^.*\\.cache\\/.*$",
+    "^.*python_packages\\/.*$",
+    "^.*resources\\/.*$",
+    "^.*tests\\/.*$",
+    "^.*migrations\\/.*$",
+    "^.*venv\\/.*$"
+]
+ignore = ["venv", ".vscode", ".cache"]
+no-docstring-rgx = "(?:^_|^[Tt]est.+|Mock.+)"
+load-plugins = ["pylint_django"]
+django-settings-module = "smoothglue.core.scripts.test_settings"
+extension-pkg-whitelist = ["math", "_datetime"]
+
+[tool.pylint."messages control"]
+disable = [
+    "missing-module-docstring",
+    "E5110",
+    "W0511",
+    "E0012",
+    "E1101",
+    "C0330",
+    "C0209",
+    "C0201",
+    "C0103",
+    "R0903",
+    "W0718",
+    "C0114",
+    "C0115",
+    "C0116",
+    "W0613",
+    "W0212",
+    "R1725z",
+    "missing-docstring",
+    "duplicate-code",
+    "invalid-name",
+    "pointless-string-statement"
+]
+
+[tool.pylint.design]
+max-parents = 15
+exclude-too-few-public-methods = ["abc.ABC"]
+
+[tool.pylint.typecheck]
+ignored-classes = ["Client", "WSGIRequest"]
+
+[tool.pylint.format]
+max-line-length = 100
+
+[tool.pylint.reports]
+output-format = "colorized"
+reports = false
+score = true
+
+[tool.isort]
+profile = "black"
+skip_glob = ["venv/**", "smoothglue/authentication/migrations/*"]
+
+[tool.coverage.run]
+include = [
+    "smoothglue/*",
+]
+command_line = "smoothglue/core/scripts/loadtests.py"
+
+[tool.coverage.report]
+exclude_also = [
+    # ignore abstract base classes
+    "class .+\\((?:abc\\.)?ABC\\)",
+]
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py"]
+addopts = "-ra -s"
+
+[tool.setuptools]
+packages = ["smoothglue.core", "smoothglue.authentication", "smoothglue.authentication.migrations", "smoothglue.tracker", "smoothglue.tracker.migrations"]
+
+

smoothglue_django_core-1.3.0/smoothglue/authentication/__init__.py

@@ -0,0 +1 @@
+default_app_config = "smoothglue.authentication.apps.AuthenticationConfig"

smoothglue_django_core-1.3.0/smoothglue/authentication/admin.py

@@ -0,0 +1,129 @@
+from django.contrib import admin
+from django.contrib.auth import get_user_model
+from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+from django.db import models
+from django.utils.html import format_html_join
+from django.utils.safestring import mark_safe
+from django_json_widget.widgets import JSONEditorWidget
+
+from smoothglue.authentication.models import (
+    OrganizationCategory,
+    OrganizationMember,
+    PlatformOrganization,
+)
+from smoothglue.core.admin import BaseAuditModelAdmin
+
+User = get_user_model()
+
+
+class OrganizationMembersInline(admin.TabularInline):
+    model = OrganizationMember
+    readonly_fields = BaseAuditModelAdmin.readonly_fields
+    fk_name = "platform_user"
+
+
+class UserAdmin(BaseUserAdmin):
+    """
+    Enhanced admin view for the User model that provides additional
+    features like filtering, searching, and a custom layout for JSON fields.
+    Some fields are read-only as they can only be changed in Keycloak.
+    """
+
+    readonly_fields = (
+        "username",
+        "email",
+    )
+    list_display = (
+        "username",
+        "email",
+        "first_name",
+        "last_name",
+        "is_staff",
+    )
+    search_fields = (
+        "username",
+        "email",
+        "first_name",
+        "last_name",
+    )
+    list_filter = (
+        "is_staff",
+        "is_superuser",
+        "is_active",
+        "groups",
+    )
+    formfield_overrides = {
+        models.JSONField: {"widget": JSONEditorWidget},
+    }
+
+    fieldsets = (
+        (None, {"fields": ("username", "email", "password")}),
+        ("Personal info", {"fields": (("first_name", "last_name"), "user_image")}),
+        (
+            "Permissions",
+            {
+                "fields": (
+                    "is_active",
+                    "is_staff",
+                    "is_superuser",
+                    "groups",
+                    "user_permissions",
+                )
+            },
+        ),
+        ("Important dates", {"fields": ("last_login", "date_joined")}),
+        ("Custom Data", {"fields": ("data",)}),
+    )
+    inlines = (OrganizationMembersInline,)
+
+
+class PlatformOrganizationsInline(admin.TabularInline):
+    model = PlatformOrganization
+    readonly_fields = BaseAuditModelAdmin.readonly_fields + ("group",)
+
+
+class PlatformOrganizationMembersInline(admin.TabularInline):
+    model = OrganizationMember
+    readonly_fields = BaseAuditModelAdmin.readonly_fields
+
+
+class PlatformOrganizationAdmin(BaseAuditModelAdmin):
+    model = PlatformOrganization
+    inlines = (
+        PlatformOrganizationsInline,
+        PlatformOrganizationMembersInline,
+    )
+    list_display = (
+        "name",
+        "parent_organization",
+        "org_category",
+        "abbreviation",
+        "child_organizations",
+    )
+    list_editable = ("parent_organization", "org_category", "abbreviation")
+
+    def child_organizations(self, obj):
+        return format_html_join(
+            mark_safe("<br>"),
+            "<a href='/admin/authentication/platformorganization/{}'>{}</>",
+            (
+                (
+                    org.id,
+                    org.name,
+                )
+                for org in obj.child_organizations.all()
+            ),
+        ) or mark_safe("-")
+
+    readonly_fields = BaseAuditModelAdmin.readonly_fields + ("group",)
+    classes = ["wide", "extrapretty"]
+
+
+class OrganizationCategoryAdmin(BaseAuditModelAdmin):
+    model = OrganizationCategory
+    list_display = ("name", "description")
+
+
+admin.site.register(User, UserAdmin)
+admin.site.register(PlatformOrganization, PlatformOrganizationAdmin)
+admin.site.register(OrganizationCategory, OrganizationCategoryAdmin)

smoothglue_django_core-1.3.0/smoothglue/authentication/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AuthenticationConfig(AppConfig):
+    name = "smoothglue.authentication"
+    verbose_name = "SmoothGlue Authentication"