Metadata-Version: 2.1
Name: eox_audit_model
Version: 0.5.1
Summary: Django eduNEXT Audit Model
Home-page: UNKNOWN
Author: eduNEXT
Author-email: contact@edunext.co
License: AGPL
Description: ==========================
        Django eduNEXT Audit Model
        ==========================
        .. image:: https://circleci.com/gh/eduNEXT/eox-audit-model.svg?style=shield
            :target: https://circleci.com/gh/eduNEXT/eox-audit-model
        
        .. image:: https://codecov.io/gh/eduNEXT/eox-audit-model/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/eduNEXT/eox-audit-model
        
        Installation
        ############
        
        1. Install eox-audit-model:
        
        .. code-block:: python
        
          pip install eox-audit-model
        
        2. Add “eox_audit_model” to your INSTALLED_APPS:
        
        .. code-block:: python
        
          INSTALLED_APPS = [
                  ...
                 'eox_audit_model',
          ]
        
        3. Run Migrate:
        
        .. code-block:: python
        
          python manage.py migrate
        
        
        Usage
        #####
        Audit any execution of a method or function. This will create a database register with the following information:
        
        1. Status. If the process was successful or not.
        2. Action. The string given to identify the process.
        3. Time stamp. The execute date.
        4. Method name. Method or function name.
        5. Captured log. logs generated in the execution.
        6. Traceback log. If there was an exception, this will contain the traceback.
        7. Site. Current site.
        8. Performer. The user who started the method, this depend on the request.user
        9. Input. The values used to execute the method.
        10. Output. The value returned by the method.
        11. Ip. Current ip.
        
        - Example:
        
        .. code-block:: python
        
          from eox_audit_model.models import AuditModel
        
          def any_method(parameter1, parameter2, parameter3):
            """Do something"""
            return 'Success'
        
          def audit_process():
            """Execute audit process"""
            action = "This is a simple action"
            parameters = {
              "args": (2, 6),
              "kwargs": {"parameter3": 9},
            }
        
            expected_value = AuditModel.execute_action(action, any_method, parameters)
            ...
        
        Decorator
        =========
        There is a simple decorator, which can perform the same process.
        
        - Example:
        
        .. code-block:: python
        
          from eox_audit_model.decorators import audit_method
        
          @audit_method(action="This is a simple action")
          def any_method(parameter1, parameter2, parameter3):
            """Do something"""
            return 'Success'
        
          def audit_process():
            """Execute audit process"""
            expected_value = any_method(3, 6, 9)
            ...
        
        
        Contributing
        ############
        
        Add your contribution policy. (If required)
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/x-rst
