Metadata-Version: 1.2
Name: hawkcatcher
Version: 1.1.2
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-Content-Type: UNKNOWN
Description: hawk.python
        ===========
        
        Python errors Catcher module for `Hawk.so <https://hawk.so>`__.
        
        .. image:: https://capella.pics/20896900-5bcf-4383-a38a-c732689f71f0
        
        Usage
        -----
        
        Register an account and get a new project token.
        
        Install module
        ~~~~~~~~~~~~~~
        
        Install ``hawkcatcher`` from PyPI.
        
        .. code:: bash
        
            $ pip install hawkcatcher
        
        Import Catcher module to your project.
        
        .. code:: python
        
            from hawkcatcher import Hawk
        
        Then enable Hawk Catcher with your token and domain.
        
        .. code:: python
        
            hawk = 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 ``hawk.catch()`` in
        except:
        
        .. code:: python
        
            try:
                ...
            except:
                hawk.catch()
        
        Init params
        ----------------------
        
        To init Hawk Catcher just pass a project token.
        
        .. code:: python
        
            hawk = Hawk('1234567-abcd-8901-efgh-123456789012')
        
        Additional params
        ~~~~~~~~~~~~~~~~~
        
        If you need to use custom Hawk server then pass a dictionary with params.
        
        .. code:: python
        
            hawk = Hawk({
                'token': '1234567-abcd-8901-efgh-123456789012',
                'host': 'hawk.so',
                'path': 'catcher/python',
                'secure': True,
            })
        
        Requirements
        ------------
        
        - Python >= 3.5
        - requests
        
        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
