Metadata-Version: 1.2
Name: django-countdowntimer-model
Version: 0.0.7
Summary: Abstract countdown timer model to use in your Django projects.
Home-page: https://github.com/bartmika/django-countdowntimer-model
Author: Bartlomiej Mika
Author-email: bart@mikasoftware.com
License: BSD 2-Clause License
Description: django-countdowntimer-model
        ===========================
        
        About
        -----
        
        The goal of this library is to allow you to inherit an abstract model in your model and turn it into a countdown time with pause and resume capability.
        
        Simply import, inherit and your model is now a timer without worrying about the complexity involved in timekeeping.
        
        This library is written to return the countdown value based on timestamps and thus does not require complicated background *tick* processes.
        
        
        Minimum Requirements
        --------------------
        - Python 3.7
        
        - Django 3.0.7
        
        
        Installation
        ------------
        Run the following in your project.
        
        .. code-block:: python
        
            pip install django-countdowntimer-model
        
        In your ``settings.p`` file please add:
        
        .. code-block:: python
        
            INSTALLED_APPS = [
                # ...
                "countdowntimer_model",
                # ...
            ]
        
        Usage
        ------------
        First you must import the abstraction into your ``model`` file.
        
        .. code-block:: python
        
            from countdowntimer_model.models import CountdownTimer
        
        Afterwords your model must inherit the abstraction.
        
        .. code-block:: python
        
            class DoomsdayCountdownTimer(CountdownTimer):
                # ...
        
        When you create your model, it is essential you set the ``duration_in_minutes``
        and ``state`` fields. Afterwords the model will handle the rest. Please note
        if you want to override to use a custom timezone then you can set the
        ``timezone_override`` field.
        
        .. code-block:: python
        
            doomsday_timer = DoomsdayCountdownTimer.object.create(
                duration_in_minutes=123,
                state=DoomsdayCountdownTimer.STATE.RUNNING,
            )
        
        Now that the object has been created you can get the latest countdown by running
        the following:
        
        .. code-block:: python
        
            remaining_t = doomsday_timer.remaining_time() # // Returned in `time` format.
        
        or
        
        .. code-block:: python
        
            remaining_minutes = doomsday_timer.remaining_time_in_minutes() # // Returned in `integer` format.
        
        
        License
        ------------
        This library is licensed under the **BSD 2-Clause License**. See `LICENSE`_ for more information.
        
        .. _LICENSE: https://github.com/bartmika/django-countdowntimer-model/blob/master/LICENSE
        
Keywords: library countdown timer elapsed remaining time django timedelta helper
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
Requires-Python: >=3.7
