Metadata-Version: 1.2
Name: hawkcatcher
Version: 0.1.0
Summary: Python errors Catcher module for Hawk.
Home-page: https://github.com/codex-team/deployserver
Author: CodeX Team
Author-email: team@ifmo.su
License: MIT
Description: hawk.python
        ===========
        
        Python errors Catcher module for `Hawk.so <https://hawk.so>`__.
        
        Usage
        -----
        
        First of all, you should register an account on
        `hawk.so <https://hawk.so/join>`__.
        
        Then `register your project <https://hawk.so/websites/create>`__.
        
        You'll get token for the project on email or you can just copy it on
        `settings page <https://hawk.so/garage/settings>`__.
        
        Install module
        ~~~~~~~~~~~~~~
        
        Install ``hawkcatcher`` from PyPI.
        
        .. code:: bash
        
            $ pip3 install hawkcatcher
        
        Import Catcher module to your project.
        
        .. code:: python
        
            from hawkcatcher import Hawk
        
        Then initialize Hawk class with your token.
        
        .. code:: python
        
            Hawk('1234567-abcd-8901-efgh-123456789012')
        
        Now all global errors would be sent to Hawk.
        
        Try-except
        ~~~~~~~~~~
        
        If you want to catch errors in try-except blocks then use ``raise`` in
        except:
        
        .. code:: python
        
            try:
                ...
            except:
                raise
        
        Custom Exceptions
        ~~~~~~~~~~~~~~~~~
        
        You can raise any exception and it would be caught.
        
        .. code:: python
        
            raise Exception('I do not understand you')
        
        Also you can use your own exceptions.
        
        .. code:: python
        
            class MyException(Exception):
        
                def __init__(self, message):
                    self.message = message
        
                def __str__(self):
                    return repr(self.message)
        
            raise MyException('Uhh, what?')
        
        Init params
        -----------
        
        There are two way to init Hawk module.
        
        Token
        ~~~~~
        
        Just enter a project token.
        
        .. code:: python
        
            Hawk('1234567-abcd-8901-efgh-123456789012')
        
        Params dictionary
        ~~~~~~~~~~~~~~~~~
        
        If you need to use custom Hawk server.
        
        .. code:: python
        
            Hawk({
                'token': '1234567-abcd-8901-efgh-123456789012',
                'domain': 'myproject.codex',
                'host': 'hawk.so',
                'path': 'catcher/python',
                'secure': True,
            })
        
        Links
        -----
        
        Repository: https://github.com/codex-team/hawk.python
        
        Report a bug: https://github.com/codex-team/hawk.python/issues
        
        PyPI Package: https://pypi.python.org/pypi/hawkcatcher
        
        CodeX Team: https://ifmo.su
        
Keywords: catcher hawk codex bug errors tracker
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Bug Tracking
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Requires-Python: >=3.5
