Metadata-Version: 2.1
Name: dj-scheduledtasks
Version: 0.0.1
Summary: ...
Home-page: https://gitlab.com/.../...
Author: AppointmentGuru
Author-email: tech@appointmentguru.co
License: UNKNOWN
Description: # dj-scheduledtasks
        
        Run tasks at a scheduled time
        
        ## Installation
        
        ```
        pip install ..
        ```
        
        ## Getting started
        
        ```python
        from scheduledtasks.models import ScheduledTask
        ```
        
        ### Schedule a task:
        
        **Explicit schedule**
        
        ```python
        # minimal usage
        ScheduledTask.schedule('example_project.tasks.remind_if_due')
        # minimal usage
        ScheduledTask.schedule('remind_if_due')
        ```
        
        **Schedule from a related object**
        
        You can also schedule infer the scheduled time from an object by passing the object instance, a field and an offset. e.g.:
        
        ```python
        # run a task 60 minutes after the due date
        ScheduledTask.schedule_by_object(
            todo,
            'example_project.tasks.remind_if_due',
            'due_date',
            offset=60
        )
        ```
        
        ### Create a task
        
        ### Ways to run a task
        
        ### Cleanup old tasks
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
