Metadata-Version: 1.0
Name: undead
Version: 0.2.0
Summary: Dead Easy UNIX Daemons!
Home-page: https://github.com/waawal/undead
Author: Daniel Waardal
Author-email: waawal@boom.ws
License: MIT
Description: undead
        ======
        
        Dead Easy POSIX Daemons for Python!
        
        -------------------------------------------------------------------------
        
        .. code:: python
        
            #!/usr/bin/python
            import undead
        
            @undead
            def my_daemon_process():
                """ This function will be daemonized. """
                from time import sleep
                while True:
                    sleep(10)
        
        -------------------------------------------------------------------------
        
        Installation
        ------------
        ::
        
            pip install undead
        
        Settings
        --------
        
        undead.name
          Name of the logger and process.
        
          Default: ``__name__`` of decorated callable
        
        undead.pidfile
          Path to pidfile.  
        
          Default: ``~/.{undead.name}/{undead.name}.pid``
        
        undead.log_level
          Log level.  
        
          Default: ``"WARNING"``
        
        undead.process_name
          The name of the process (that shows up in ps etc.)
        
          Default: None (No manipulation of process name)
        
        Example
        *******
        
        .. code:: python
        
            import undead
            from logbook import SyslogHandler
        
            undead.name = "my-first-daemon"
            undead.process_name = "leDeamon"
        
            @undead
            def my_daemon_process():
                """ This function will be daemonized. """
                # ...
        
        Logging within the decorated handler
        ------------------------------------
        
        Just add ``log`` to your decorated signature, and the logger will be passed down. Log away captain!
        
        .. code:: python
        
            import undead
        
            @undead
            def i_am_undead(log):
                log.warning("I'm warning you!")
                log.info("Soap, 2 for $1.99")
        
        The logfile will be created in ``~/.i_am_undead``
        
        License
        -------
        
        MIT
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Systems Administration
