Metadata-Version: 2.1
Name: oom
Version: 0.0.4
Summary: Prevents your machine from freezing when it's running out of RAM
Home-page: https://gitlab.com/aduard.kononov/oom
Author: Eduard Konanau
Author-email: aduard.kononov@gmail.com
License: UNKNOWN
Description: # Out Of ~~Mana~~ Memory
        
        Provides a function that keeps an eye on your RAM and stops executing of the process if you are running out of memory.
        
        ### Example 1: The simplest
        ```python
        from oom import exit_on_out_of_ram
        
        one_gigabyte = 1 << 30
        exit_on_out_of_ram(one_gigabyte)
        
        # explode your RAM
        extremely_big_number = 1 << 9999999
        _ = [i for i in range(extremely_big_number)]
        ```
        
        ### Example 2: Full
        ```python
        from oom import exit_on_out_of_ram
        
        one_gigabyte = 1 << 30
        exit_on_out_of_ram(
            terminate_on=one_gigabyte,
            warn_on = 2 * one_gigabyte,
            sleep_time=1,
            notify_about_using=True
        )
        
        # explode your RAM
        extremely_big_number = 1 << 9999999
        _ = [i for i in range(extremely_big_number)]
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
