micro-users 1.3.0__py3-none-any.whl → 1.3.2__py3-none-any.whl

micro_users-1.3.2.dist-info/METADATA

@@ -0,0 +1,282 @@
+Metadata-Version: 2.1
+Name: micro-users
+Version: 1.3.2
+Summary: Arabic Django user management app with abstract user, permissions, and activity logging
+Home-page: https://github.com/debeski/micro-users
+Author: DeBeski
+Author-email: DeBeski <debeski1@gmail.com>
+License: MIT
+Keywords: django,users,permissions,authentication
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django (>=5.1)
+Requires-Dist: django-crispy-forms (>=2.4)
+Requires-Dist: django-tables2 (>=2.7)
+Requires-Dist: django-filter (>=24.3)
+Requires-Dist: pillow (>=11.0)
+Requires-Dist: babel (>=2.1)
+
+# Micro Users - Arabic Django User Management App
+
+[![PyPI version](https://badge.fury.io/py/micro-users.svg)](https://pypi.org/project/micro-users/)
+
+**Arabic** lightweight, reusable Django app providing user management with abstract user, permissions, localization, and activity logging.
+
+## Requirements
+- **Must be installed on a fresh database.**
+- Python 3.11+
+- Django 5.1+
+- django-crispy-forms 2.4+
+- django-tables2 2.7+
+- django-filter 24.3+
+- pillow 11.0+
+- babel 2.1+
+
+## Features
+- Custom AbstractUser model
+- User permissions system  
+- Activity logging (login/logout, CRUD tracking)
+- Specific User detail and log view *new*
+- Localization support
+- Admin interface integration
+- CRUD views and templates
+- Filtering and tabulation
+
+## Installation
+
+```bash
+pip install git+https://github.com/debeski/micro-users.git
+# OR local
+pip install micro-users
+```
+
+## Configuration
+
+1. Add to `INSTALLED_APPS`:
+```python
+INSTALLED_APPS = [
+    'users',  # Preferably on top
+    'django.contrib.admin',
+    'django.contrib.auth',
+    ...
+]
+```
+
+2. Set custom user model in settings.py:
+```python
+AUTH_USER_MODEL = 'users.CustomUser'
+```
+
+3. Include URLs in your main project folder `urls.py`:
+```python
+urlpatterns = [
+    ...
+    path('manage/', include('users.urls')),
+]
+```
+
+4. Run migrations:
+```bash
+python manage.py migrate users
+```
+
+## How to Use
+
+Once configured, the app automatically handles user management and activity logging. Ensure your project has a `base.html` template in the root templates directory, as all user management templates extend it.
+
+### Activity Logging
+
+The app automatically logs **LOGIN** and **LOGOUT** actions. For custom logging of other actions in your application, you can use the following helper functions:
+
+#### Available Helper Functions
+
+1. **Get Client IP** - Extract the user's IP address from request:
+```python
+from users.signals import get_client_ip
+
+# Usage in views
+ip_address = get_client_ip(request)
+```
+
+2. **Log User Action** - Create a reusable logging function:
+```python
+from django.utils import timezone
+from users.models import UserActivityLog
+from users.signals import get_client_ip
+
+def log_user_action(request, instance, action, model_name):
+    """
+    Logs a user action to the activity log.
+    
+    Args:
+        request: HttpRequest object
+        instance: The model instance being acted upon
+        action: Action type (see ACTION_TYPES below)
+        model_name: Name of the model/entity (in Arabic or English)
+    """
+    UserActivityLog.objects.create(
+        user=request.user,
+        action=action,
+        model_name=model_name,
+        object_id=instance.pk,
+        number=instance.number if hasattr(instance, 'number') else '',
+        timestamp=timezone.now(),
+        ip_address=get_client_ip(request),
+        user_agent=request.META.get("HTTP_USER_AGENT", ""),
+    )
+```
+
+#### Action Types Available
+Use these constants when logging actions:
+
+| Action Constant | Arabic Display | Description |
+|-----------------|----------------|-------------|
+| `'LOGIN'` | تسجيل دخـول | User login (auto-logged) |
+| `'LOGOUT'` | تسجيل خـروج | User logout (auto-logged) |
+| `'CREATE'` | انشـاء | Object creation |
+| `'UPDATE'` | تعديـل | Object modification |
+| `'DELETE'` | حــذف | Object deletion |
+| `'VIEW'` | عـرض | Object viewing |
+| `'DOWNLOAD'` | تحميل | File download |
+| `'CONFIRM'` | تأكيـد | Action confirmation |
+| `'REJECT'` | رفــض | Action rejection |
+| `'RESET'` | اعادة ضبط | Password/Data reset |
+
+#### Usage Examples
+
+1. **Logging a CREATE action**:
+```python
+def create_document(request):
+    # ... create logic ...
+    document = Document.objects.create(...)
+    
+    # Log the action
+    from users.models import UserActivityLog
+    from users.signals import get_client_ip
+    
+    UserActivityLog.objects.create(
+        user=request.user,
+        action='CREATE',
+        model_name='وثيقة',
+        object_id=document.pk,
+        number=document.number,
+        ip_address=get_client_ip(request),
+        user_agent=request.META.get("HTTP_USER_AGENT", ""),
+    )
+```
+
+2. **Using the helper function**:
+```python
+# Create a helper function in your app
+def log_action(request, instance, action, model_name):
+    from users.models import UserActivityLog
+    from users.signals import get_client_ip
+    from django.utils import timezone
+    
+    UserActivityLog.objects.create(
+        user=request.user,
+        action=action,
+        model_name=model_name,
+        object_id=instance.pk,
+        number=getattr(instance, 'number', ''),
+        timestamp=timezone.now(),
+        ip_address=get_client_ip(request),
+        user_agent=request.META.get("HTTP_USER_AGENT", ""),
+    )
+
+# Usage in views
+def update_order(request, order_id):
+    order = get_object_or_404(Order, pk=order_id)
+    # ... update logic ...
+    log_action(request, order, 'UPDATE', 'طلب')
+```
+
+3. **Logging without an instance** (for general actions):
+```python
+def log_general_action(request, action, model_name, description=''):
+    from users.models import UserActivityLog
+    from users.signals import get_client_ip
+    from django.utils import timezone
+    
+    UserActivityLog.objects.create(
+        user=request.user,
+        action=action,
+        model_name=model_name,
+        object_id=None,
+        number=description,
+        timestamp=timezone.now(),
+        ip_address=get_client_ip(request),
+        user_agent=request.META.get("HTTP_USER_AGENT", ""),
+    )
+
+# Usage
+log_general_action(request, 'CONFIRM', 'نظام', 'تم تأكيد الإعدادات')
+```
+
+## Available URLs
+
+All user management URLs are prefixed with `manage/` as configured. Below is the complete list:
+
+| URL Pattern | View/Function | Description |
+|-------------|---------------|-------------|
+| `manage/login/` | `auth_views.LoginView.as_view()` | User login |
+| `manage/logout/` | `auth_views.LogoutView.as_view()` | User logout |
+| `manage/users/` | `views.UserListView.as_view()` | List all users |
+| `manage/users/create/` | `views.create_user` | Create new user |
+| `manage/users/edit/<int:pk>/` | `views.edit_user` | Edit existing user |
+| `manage/users/delete/<int:pk>/` | `views.delete_user` | Delete user |
+| `manage/users/<int:pk>/` | `views.UserDetailView.as_view()` | View user details |
+| `manage/profile` | `views.user_profile` | View current user profile |
+| `manage/profile/edit/` | `views.edit_profile` | Edit current profile |
+| `manage/logs/` | `views.UserActivityLogView.as_view()` | View activity logs |
+| `manage/reset_password/<int:pk>/` | `views.reset_password` | Reset user password |
+
+## Structure
+```
+users/
+├── views.py        # CRUD operations
+├── urls.py         # URL routing
+├── tables.py       # User and Activity Log tables
+├── signals.py      # Logging signals
+├── models.py       # User model, permissions, activity logs
+├── forms.py        # Creation, edit,. etc.
+├── filter.py       # Search filters
+├── apps.py         # Permissions Localization
+├── admin.py        # Admin UI integration
+├── __init__.py     # Python init
+├── templates/      # HTML templates
+├── static/         # CSS classes
+└── migrations/     # Database migrations
+```
+
+## Version History
+
+| Version  | Changes |
+|----------|---------|
+| v1.0.0   | • Initial release as pip package |
+| v1.0.1   | • Fixed a couple of new issues as a pip package |
+| v1.0.2   | • Fixed the readme and building files |
+| v1.0.3   | • Still getting the hang of this pip publish thing |
+| v1.0.4   | • Honestly still messing with and trying settings and stuff out |
+| v1.1.0   | • OK, finally a working seamless micro-users app |
+| v1.1.1   | • Fixed an expolit where a staff member could disable the ADMIN user |
+| v1.2.0   | • Added User Details view with specific user activity log |
+| v1.2.1   | • Fixed a minor import bug |
+| v1.2.3   | • Separated user detail view from table for consistency<br> • Optimized the new detail + log view for optimal compatibiliyy with users |
+| v1.2.4   | • Fixed a couple of visual inconsistencies |
+| v1.3.0   | • Patched a critical security permission issue<br> • Disabled ADMIN from being viewed/edited from all other members<br> • Fixed a crash when sorting with full_name<br> • Enabled Logging for all actions |
+| v1.3.1   | • Corrected a misplaced code that caused a crash when editing profile |
+| v1.3.2   | • Minor table modifications |

{micro_users-1.3.0.dist-info → micro_users-1.3.2.dist-info}/RECORD

@@ -5,9 +5,9 @@ users/filters.py,sha256=neOdbyOSYVQXAQ2vKAW-0bcj7KIh9xc8UboHTlaZU4Q,4785
 users/forms.py,sha256=GHC8pFm2i9PD3MVaakrgMXEszsBrXieHq7DYiAfo8Fw,14977
 users/models.py,sha256=V_SIyGGq2w_bww7YufMjqXMSKN1u9CkSMPuOLiwPjtc,2100
 users/signals.py,sha256=5Kd3KyfPT6740rvwZj4vy1yXsmjVhmaQ__RB8p5R5aE,1336
-users/tables.py,sha256=WwC7BMpzNrcfEatJj6gHMP8k_FGqer-Zfn9vZRB7kZo,2196
+users/tables.py,sha256=2HiDXa_4Hq1at86vfbhg1U3NobMjMWXTVQIJz3AizmQ,2088
 users/urls.py,sha256=FwQ9GVOBRQ4iXQ9UyLFI0aEAga0d5qL_miPNpmFPA-Q,1022
-users/views.py,sha256=_O6xRoej-JW4u-9vTK55Jr4SVRpgL2qG1BSx1o6xYRs,8741
+users/views.py,sha256=oJLsr_G7TJP3Y6lRdkoP2oNVGe8tYD3x8I4ARO_iDA8,8730
 users/migrations/0001_initial.py,sha256=lx9sSKS-lxHhI6gelVH52NOkwqEMJ32TvOJUn9zaOXM,4709
 users/migrations/0002_alter_useractivitylog_action.py,sha256=I7NLxgcPTslCMuADcr1srXS_C_0y_LcZiAFFHBG5NsE,715
 users/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,8 +21,8 @@ users/templates/users/profile_edit.html,sha256=L9DUHlQHG-PmxwxBbSjgPk1dEmy0spPi6
 users/templates/users/user_actions.html,sha256=J44-sn0fMbLUWjdtlcf5YhgT5OYRykr1mFkeVXoI1ew,1543
 users/templates/users/user_detail.html,sha256=QkJ-6jdtUdi8mM-V_MzqYcdoEkzXEsIeFMliNjgIOsc,2053
 users/templates/users/user_form.html,sha256=jcyI7OQZOY4ue4DajPtfjAt2SmAYO5ZgHNOqTp2-FO0,1352
-micro_users-1.3.0.dist-info/LICENSE,sha256=Fco89ULLSSxKkC2KKnx57SaT0R7WOkZfuk8IYcGiN50,1063
-micro_users-1.3.0.dist-info/METADATA,sha256=tI_SdrsRx0JA1ppDV95GZUzYeOVvoUYzt7cPvEDUelQ,4277
-micro_users-1.3.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-micro_users-1.3.0.dist-info/top_level.txt,sha256=tWT24ZcWau2wrlbpU_h3mP2jRukyLaVYiyHBuOezpLQ,6
-micro_users-1.3.0.dist-info/RECORD,,
+micro_users-1.3.2.dist-info/LICENSE,sha256=Fco89ULLSSxKkC2KKnx57SaT0R7WOkZfuk8IYcGiN50,1063
+micro_users-1.3.2.dist-info/METADATA,sha256=ov27iIs5nPtYsDN6RZVro1vm3SRGwSn0qaaXufBKrdA,9713
+micro_users-1.3.2.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+micro_users-1.3.2.dist-info/top_level.txt,sha256=tWT24ZcWau2wrlbpU_h3mP2jRukyLaVYiyHBuOezpLQ,6
+micro_users-1.3.2.dist-info/RECORD,,

users/tables.py

@@ -1,5 +1,3 @@
-# Imports of the required python modules and libraries
-######################################################
 import django_tables2 as tables
 from django.contrib.auth import get_user_model
 from .models import UserActivityLog
@@ -9,7 +7,11 @@ User = get_user_model()  # Use custom user model
 class UserTable(tables.Table):
     username = tables.Column(verbose_name="اسم المستخدم")
     email = tables.Column(verbose_name="البريد الالكتروني")
-    full_name = tables.Column(verbose_name="الاسم بالكامل", orderable=False,)
+    full_name = tables.Column(
+        verbose_name="الاسم الكامل",
+        accessor='user.full_name',
+        order_by='user__first_name'
+    )
     is_staff = tables.BooleanColumn(verbose_name="مسؤول")
     is_active = tables.BooleanColumn(verbose_name="نشط")
     last_login = tables.DateColumn(
@@ -22,7 +24,6 @@ class UserTable(tables.Table):
         orderable=False,
         verbose_name=''
     )
-
     class Meta:
         model = User
         template_name = "django_tables2/bootstrap5.html"
@@ -30,13 +31,12 @@ class UserTable(tables.Table):
         attrs = {'class': 'table table-hover align-middle'}
 
 class UserActivityLogTable(tables.Table):
-    user = tables.Column(verbose_name="اسم الدخول")
     timestamp = tables.DateColumn(
         format="H:i Y-m-d ",  # This is the format you want for the timestamp
         verbose_name="وقت العملية"
     )
     full_name = tables.Column(
-        verbose_name="الاسم بالكامل",
+        verbose_name="الاسم الكامل",
         accessor='user.full_name',
         order_by='user__first_name'
     )

users/views.py

@@ -100,6 +100,12 @@ def create_user(request):
 @user_passes_test(is_staff)
 def edit_user(request, pk):
     user = get_object_or_404(User, pk=pk)
+    
+    # 🚫 Block staff users from editing superuser accounts
+    if user.is_superuser and not request.user.is_superuser:
+        messages.error(request, "لا يمكن تعديل هذا الحساب!")
+        return redirect('manage_users')
+
     form_reset = ResetPasswordForm(user, data=request.POST or None)
 
     if request.method == "POST":
@@ -216,12 +222,6 @@ def user_profile(request):
 # Function for editing the user profile
 @login_required
 def edit_profile(request):
-
-    # 🚫 Block staff users from editing superuser accounts
-    if request.user.is_superuser and not request.user.is_superuser:
-        messages.error(request, "لا يمكنك تعديل حساب المدير!")
-        return redirect('user_profile')
-
     if request.method == 'POST':
         form = UserProfileEditForm(request.POST, request.FILES, instance=request.user)
         if form.is_valid():
@@ -231,9 +231,6 @@ def edit_profile(request):
             return redirect('user_profile')
         else:
             messages.error(request, 'حدث خطأ أثناء حفظ التغييرات')
-
     else:
         form = UserProfileEditForm(instance=request.user)
-
     return render(request, 'users/profile_edit.html', {'form': form})
-

micro_users-1.3.0.dist-info/METADATA

@@ -1,132 +0,0 @@
-Metadata-Version: 2.1
-Name: micro-users
-Version: 1.3.0
-Summary: Arabic Django user management app with abstract user, permissions, and activity logging
-Home-page: https://github.com/debeski/micro-users
-Author: DeBeski
-Author-email: DeBeski <debeski1@gmail.com>
-License: MIT
-Keywords: django,users,permissions,authentication
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 5
-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
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: Django (>=5.1)
-Requires-Dist: django-crispy-forms (>=2.4)
-Requires-Dist: django-tables2 (>=2.7)
-Requires-Dist: django-filter (>=24.3)
-Requires-Dist: pillow (>=11.0)
-Requires-Dist: babel (>=2.1)
-
-# Micro Users - Arabic Django User Management App
-
-[![PyPI version](https://badge.fury.io/py/micro-users.svg)](https://pypi.org/project/micro-users/)
-
-**Arabic** lightweight, reusable Django app providing user management with abstract user, permissions, localization, and activity logging.
-
-
-## Requirements
-- **Must be installed on a fresh database.**
-- Python 3.11+
-- Django 5.1+
-- django-crispy-forms 2.4+
-- django-tables2 2.7+
-- django-filter 24.3+
-- pillow 11.0+
-- babel 2.1+
-
-
-## Features
-- Custom AbstractUser model
-- User permissions system  
-- Activity logging (login/logout, CRUD tracking)
-- Specific User detail and log view *new*
-- Localization support
-- Admin interface integration
-- CRUD views and templates
-- Filtering and tabulation
-
-## Installation
-
-```bash
-pip install git+https://github.com/debeski/micro-users.git
-# OR local
-pip install micro-users
-```
-
-## Configuration
-
-1. Add to `INSTALLED_APPS`:
-```python
-INSTALLED_APPS = [
-    'users',  # Preferably on top
-    'django.contrib.admin',
-    'django.contrib.auth',
-    ...
-]
-```
-
-2. Set custom user model in settings.py:
-```python
-AUTH_USER_MODEL = 'users.CustomUser'
-```
-
-3. Include URLs in your main project folder `urls.py`:
-```python
-urlpatterns = [
-    ...
-    path('manage/', include('users.urls')),
-]
-```
-
-4. Run migrations:
-```bash
-python manage.py migrate users
-```
-
-
-## Structure
-```
-users/
-├── views.py        # CRUD operations
-├── urls.py         # URL routing
-├── tables.py       # User and Activity Log tables
-├── signals.py      # Logging signals
-├── models.py       # User model, permissions, activity logs
-├── forms.py        # Creation, edit,. etc.
-├── filter.py       # Search filters
-├── apps.py         # Permissions Localization
-├── admin.py        # Admin UI integration
-├── __init__.py     # Python init
-├── templates/      # HTML templates
-├── static/         # CSS classes
-└── migrations/     # Database migrations
-```
-
-## Version History
-
-| Version  | Changes |
-|----------|---------|
-| v1.0.0   | • Initial release as pip package |
-| v1.0.1   | • Fixed a couple of new issues as a pip package |
-| v1.0.2   | • Fixed the readme and building files |
-| v1.0.3   | • Still getting the hang of this pip publish thing |
-| v1.0.4   | • Honestly still messing with and trying settings and stuff out |
-| v1.1.0   | • OK, finally a working seamless micro-users app |
-| v1.1.1   | • Fixed a bug where a staff member can edit the admin details |
-| v1.2.0   | • Added User Details view with specific user activity log |
-| v1.2.1   | • Fixed a minor import bug |
-| v1.2.3   | • Separated user detail view from table for consistency<br> • Optimized the new detail + log view for optimal compatibiliyy with users |
-| v1.2.4   | • Fixed a couple of visual inconsistencies |
-| v1.3.0   | • Patched a critical security permission issue<br> • Disabled ADMIN from being viewed/edited from other staff members<br> • Fixed an issue when sorting with full_name<br> • Enabled Logging for all actions |