Metadata-Version: 1.0
Name: signalsdb
Version: 0.1.1
Summary: Query Unix signals
Home-page: https://github.com/eugene-eeo/signalsdb
Author: Eeo Jun
Author-email: packwolf58@gmail.com
License: MIT
Description: |logo| SignalsDB
        ================
        
        SignalsDB is an MIT-licensed library written in Python providing
        a simple way to query a curated database of Unix signals.
        
        Usage:
        ------
        
        To explain a Unix signal based on the integer id::
        
            >>> from signalsdb.api import explain
            >>> explain(13)
            {'action': 'kill',
             'description': 'write on a pipe with no reader',
             'id': 13,
             'signal': 'SIGPIPE'}
        
        Then to query the signals DB based on the signal name or action
        in a case insensitive way using regexes::
        
            >>> from signalsdb.api import search
            >>> search(signal='sigp\w', action='kill')
            [{'action': 'kill',
              'description': 'write on a pipe with no reader',
              'id': 13,
              'signal': 'SIGPIPE'},
             {'action': 'kill',
              'description': 'profiling timer alarm',
              'id': 27,
              'signal': 'SIGPROF'}]
        
        Installation:
        -------------
        
        From PyPI::
        
            $ pip install signalsdb
        
        For hacking on SignalsDB it is recommended that you install
        from the git repository::
        
            $ git clone git@github.com:eugene-eeo/signalsdb.git
            $ cd signalsdb
            $ pip install .
        
        
        .. |logo| image:: https://raw.githubusercontent.com/eugene-eeo/signalsdb/master/media/logo-small.png
        
Keywords: signals,unix,db
Platform: UNKNOWN
