Metadata-Version: 2.1
Name: hooked-on-django
Version: 0.1.0
Summary: Simple django application to trigger hooked methods.
Home-page: https://github.com/fedecalendino/hooked-on-django
Author: Fede Calendino
Author-email: fede@calendino.com
License: MIT
Project-URL: Source, https://github.com/fedecalendino/hooked-on-django
Description: ## hooked-on-django 
        
        [![Version](https://img.shields.io/pypi/v/hooked--on--django?label=pypi&color=blue&logo=pypi)](https://pypi.org/project/hooked-on-django)
        
        
        ### startup hook
        
        All methods listed under this hook will be executed after Django finishes its startup process.
        
        
        `settings.py`
        
        ```python
        INSTALLED_APPS = [
            ...,
            "hooks.startup",
            ...,
        ]
        
        DJANGO_HOOKS = {
            "STARTUP": {
                "path.to.method": {
                    "delay": 0,
                    "args" : [
                        ...
                    ],
                    "kwargs": {
                        ...
                    },
                }
            }
        }
        ```
        
        ##### examples
        
        ```
        file: /path/to.py
        
        def method(param1: str, param2: int):
            ...
        
        def other(param1: str = "", param2: int = 0):
            ...
        
        def another():
            ... 
        ```
        
        To add a hook to each of these methods, the following configuration can be used:
        
        
        ```
        DJANGO_HOOKS = {
            "STARTUP": {
                "path.to.method": {
                    "delay": 10,
                    "args": ["string", 123456]
                },
                "path.to.other": {
                    "kwargs": {
                        "param1": "string", 
                        "param2": 123456
                    }
                },
                "path.to.other": {},  # No params needed.
            }
        }
        ```
        
        note: additionaly, the method `method` will be executed after a 10 seconds delay.
        
        🎣️
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Description-Content-Type: text/markdown
