GitLocker: The Coding Marketplace

Description:

djangouserinteractionlog 1.0.1

Description
Django User Interaction Log keeps the log record of any operation on a Django
based application. Such as an user views a page on a Django application
then it may keeps record of the event. Like ‘ExampleUser has performed
read operation on ExampleCar at /example/path/ 10 minutes ago’. This is
a dummy log record.

Requirements
This package only needs Django to run.

Version
Current stable version is 1.0

Compatibility
This package is Tox tested with Python version 3.6, 3.7 and 3.8 with Django
version 2.0, 2.1, 2.2, 3.0, 3.1. However, this package is compatible with
Python version > 3.0 and Django version > 2.0 but not compatible with
Python 2.7 and Django version < 2.0

Installation
This package can be installed in two ways. One is via the pypi package manager
and other is directly from the Github.
For pypi installation please use the following command
pip install django_user_interaction_log
And for directly downloading from the Github repository use the following
commands
git clone https://github.com/saanpritom/django_user_interaction_log.git
After successful installation open Django’s settings.py file and add
‘django_user_interaction_log’, on your INSTALLED_APPS list.
INSTALLED_APPS = [
...
'django_user_interaction_log',
]
Include the event loggers URLconf in your project urls.py like this
path('django_user_interaction_log/', include('django_user_interaction_log.urls')),
Here you can put whatever you like on the path. Now run the app migration for
creating the database migrations
python manage.py makemigrations
python manage.py migrate
For Customizing settings there is a directory available for settings.py
file. However, if you do not put the dictionary on the settings.py file
then it will use the default values for the keys.
DJANGO_USER_INTERACTION_LOG_SETTINGS = {
'sensitive_test_cases': True,
'user_representer_field': '__str__',
'list_paginated_by': 100,
}
These are the default values for the keywords.

‘sensitive_test_cases’ means the package will run some test cases
that are dependent on a specific environment. Most of the cases these
tests will not create any error However, if it does then just make it
False to avoid those test cases running
‘user_representer_field’ means the default field that will be used to
construct the full log message for the actor. ‘str’ means it is
pointing to the get_user_model default str method. If you want to
change it then please write the valid name of a user field. Example:
‘user_representer_field’: ‘email’ This will print email as the
default field for the actor
‘list_paginated_by’ means the pagination number for the log_list
page. It is an integer number. Default is 100 but you can put any
valid integer value

Basic Usage
This package ships with one Django Mixin for class based views and one
function for function based views. The full example can be found on
examples.py file. However, the examples are explained below:

Function Based Views:
on your views.py file import the following module
from django_user_interaction_log.registrars import create_log_record
and on your function based view just add this method as below
def example_function_based_view(request):
"""This example is for the function based view users"""
target_object = None
if get_user_model().objects.filter().exists():
target_object = get_user_model().objects.first()
create_log_record(request=request, log_detail='django_user_interaction_log example function view test operation',
log_target=target_object)
return render(request, 'example_templates/example_template.html')
Here the create_log_record() function is taking 3 optional arguments.

request (Which is a Django HttpRequest object. If not provide then
it’s default value is None)
log_detail (A text describing the action performed on that view by
the user. If not provided then it’s default value is None)
log_target (The instance of the page object. Suppose the page is
showing a Detail view of Books. so the log_target will be the single
book object. If the page is a list page and there are multiple
objects or no particular object then just do not use the log_target
argument. On that case it will use None as the default value. If any
string, integer or float number has passed to this argument then it
will raise a ValidationError)

Class Based Views:
on the views.py file import the following Mixin
from django_user_interaction_log.mixins import DjangoUserInteractionLogMixin
and on any class based views use this mixin as follow:
class ExampleViewWithMixin(DjangoUserInteractionLogMixin, TemplateView):
"""This example is for the class based view users"""
template_name = 'example_templates/example_template.html'
django_user_interaction_log_detail_message = 'django_user_interaction_log example class view test operation'

def get_log_target_object(self, request, *args, **kwargs):
if get_user_model().objects.filter().exists():
return get_user_model().objects.first()
return None
Here two things to notice that the ‘django_user_interaction_log_log_detail_message’ and
‘get_log_target_object()’

‘django_user_interaction_log_log_detail_message’ holds the action message performed
by the user on this view. If not assign then it will use the default
None
‘get_log_target_object()’ this method returns the instance of the
target object. Same as the log_target on the function based view.
Just pass this view specific object here. If the page is a list view
or there are no specific target_object then do not override this
method. If not overridden the this will use the default value which
is None

Log Records List
There are two views for the stored log records of this application. But
one cannot add, update or delete anything on these records through these
views. To add, delete or update a log record the user must have to use
the Django default Admin Panel. Where this app will be found on the name
of ‘Event Logger’

The default list view can be checked from this URL

https://your-ip-or-domain/django_user_interaction_log/
with ?format=table or ?format=file will show table and file formatted
lists of the logs. For a detail table format view the URL will be
https://your-ip-or-domain/django_user_interaction_log/?format=table and for a file
format view the URL will be
https://your-ip-or-domain/django_user_interaction_log/?format=file

The default detail view can be checked from this URL

https://your-ip-or-domain/django_user_interaction_log/3/
Here 3 is the primary key for that particular log record

Package Creator
This package is created by Pritom Borogoria. The package is inspired by
Django Activity Stream