📖 createtask docs

Author: danyi1212

README.rst

@@ -30,6 +30,7 @@ Features
 - Authorize against **Active Directory** using `ldap3 <https://ldap3.readthedocs.io/en/latest/>`_ package
 - Manage **LDAP Connections** for easy integrations
 - Debug using `django-debug-toolbar <https://django-debug-toolbar.readthedocs.io/en/latest/>`_
+- **NEW** Create Task Schedulers for Django management commands
 
 Quick Start
 -----------

docs/source/howto/create_tasks.rst

@@ -0,0 +1,64 @@
+
+Create Task Scheduler Jobs
+==========================
+
+It is usually necessary to **execute tasks** from you project on a schedule.
+This module has a shortcut to create scheduled jobs for **Django management commands** in the **Windows Task Scheduler**.
+
+.. warning::
+    This feature requires the installation of the ``pywin32`` module.
+    Install it with ``pip install pywin32``
+
+Create a task
+-------------
+
+Creating a new task is done with the ``createtask`` command.
+
+For example, lets say you want to run the following command every hour::
+
+$ py manage.py say_hello --new-users
+
+You can create a schedule with this command::
+
+$ py manage.py createtask "say_hello --new-users" -i hours=1
+
+Now the following command will be executed every hour by the Windows Task Scheduler.
+
+Using predefined tasks
+----------------------
+
+Included with this module are some **predefined tasks** for some Django and Third-Party app management commands.
+Those commands can be created using the ``--predefined`` or ``-p`` argument
+
+:clearsessions:
+    Clear expired sessions from database, once a week::
+
+    $ py manage.py createtask clearsessions -p
+
+.. seealso::
+    See more at https://docs.djangoproject.com/en/3.1/ref/django-admin/#django-admin-clearsessions
+
+:clean_duplicate_history:
+    Clean duplicate history records from all models with history every 3 hours (from django-simple-history)::
+
+    $ py manage.py createtask clean_duplicate_history -p
+
+:clean_old_history:
+    Clean history records older then 30 days from all models with history every day (from django-simple-history)::
+
+    $ py manage.py createtask clean_old_history -p
+
+
+.. seealso::
+    See more at https://django-simple-history.readthedocs.io/en/latest/utils.html#utils
+
+:process_tasks:
+    Worker for background tasks processing (from django-background-tasks)::
+
+    $ py manage.py createtask process_tasks -p
+
+
+You can also create **multiple workers** by specifying different names with ``--name`` argument.
+
+.. seealso::
+    See more at https://django-background-tasks.readthedocs.io/en/latest/#running-tasks

docs/source/index.rst

@@ -15,6 +15,7 @@ Features
 - Authorize against Active Directory using `ldap3 <https://ldap3.readthedocs.io/en/latest/>`_ package
 - Manage LDAP connections for easy integrations
 - Debug using `django-debug-toolbar <https://django-debug-toolbar.readthedocs.io/en/latest/>`_
+- **NEW** Create Task Schedulers for Django management commands
 
 .. toctree::
    :maxdepth: 1
@@ -30,6 +31,7 @@ Features
    :caption: How-to Guides
 
    howto/serve_static
+   howto/create_tasks
    howto/custom_user_fields
    howto/using_ldap_manager
    howto/manage_secrets

docs/source/reference/change_log.rst

@@ -8,6 +8,7 @@ Change Log
 Release date: coming soon
 
 - **ADDED**: LDAPUserManager for manually creating users from LDAP.
+- **ADDED**: ``createtask`` management command for creating Task Scheduler jobs.
 - **IMPROVED**: LDAP Settings for Group Membership check propagate to one another.
 - **MODIFIED**: Increased the default ``WAUTH_RESYNC_DELTA`` to every 1 day.
 

docs/source/reference/management_commands.rst

@@ -21,4 +21,27 @@ Arguments
 
 .. warning::
     In order for the ``web.config`` files to work correctly, you will need to **unlock** some IIS Configuration Section.
-    See the **Install and Setup IIS** section at :doc:`../installation/installation` docs.
+    See the **Install and Setup IIS** section at :doc:`../installation/installation` docs.
+
+createtask
+----------
+
+Add a management command to Windows Task Scheduler.
+
+Arguments
+    * **command** Management command, wrapped with "command".
+    * **--predefined**, **-p** Create from a predefined task.
+    * **--name**, **-n** Task name.
+    * **--desc**, **-d** Task description.
+    * **--identity**, **-u** Task principal identity (default: "NT Authority\\LocalSystem").
+    * **--folder**, **-f** Task folder location (default: Project's name).
+    * **--interval**, **-i** Task execution interval as timedelta kwargs, e.g. "days=1,hours=12.5".
+    * **--random**, **-r** Randomize execution time as timedelta kwargs, e.g. "days=1,hours=12.5".
+    * **--timeout**, **-t** Execution time limit as timedelta kwargs, e.g. "days=1,hours=12.5" (default: 1 hour).
+    * **--priority** Task priority https://docs.microsoft.com/en-us/windows/win32/taskschd/tasksettings-priority
+
+Predefined tasks
+    * **clearsessions** Clear sessions from database every week.
+    * **clean_duplicate_history** Clean duplicate history records from all models with history every 3 hours (from django-simple-history).
+    * **clean_old_history** Clean history records older then 30 days from all models with history every day (from django-simple-history).
+    * **process_tasks** Worker for background tasks processing (from django-background-tasks).

windows_auth/management/commands/createtask.py

@@ -46,7 +46,7 @@ class Command(BaseCommand):
     def add_arguments(self, parser: CommandParser):
         parser.add_argument("command", help="Management command, wrapped with \"command\"")
         parser.add_argument("-p", "--predefined", action="store_true",
-                            help=f"Create a predefined task {tuple(PREDEFINED_TASKS.keys())}")
+                            help=f"Create from a predefined task {tuple(PREDEFINED_TASKS.keys())}")
         parser.add_argument("-n", "--name", type=str, help="Task name")
         parser.add_argument("-d", "--desc", type=str, default="", help="Task description")
         parser.add_argument("-u", "--identity", type=str, default=LOCAL_SERVICE, help="Task principle identity"),