Metadata-Version: 1.1
Name: bugzscout-py
Version: 0.0.1
Summary: Python interface for the FogBugz BugzScout API.
Home-page: https://github.com/thomasvandoren/bugzscout-py
Author: Thomas Van Doren
Author-email: thomas@thomasvandoren.com
License: BSD
Description: bugzscout-py
        ============
        Python interface for the FogBugz BugzScout API.
        
        .. image:: https://travis-ci.org/thomasvandoren/bugzscout-py.png?branch=master
            :target: https://travis-ci.org/thomasvandoren/bugzscout-py
        
        Installation
        ------------
        
        .. code-block:: bash
        
            pip install bugzscout-py
        
        Supported python versions
        ~~~~~~~~~~~~~~~~~~~~~~~~~
        
        * 2.6, 2.7
        * 3.1, 3.2, 3.3
        * pypy
        
        Getting Started
        ---------------
        
        .. code-block:: pycon
        
            >>> import bugzscout
            >>> b = bugzscout.BugzScout('http://fogbugz/scoutSubmit.asp',
                                        'fb-user',
                                        'the-project',
                                        'the-area')
            >>> b.submit_error('An eror occurred of type blah', extra='Extra info')
        
        Command Line Interface
        ~~~~~~~~~~~~~~~~~~~~~~
        
        There is a command line interface for submitting errors. To simplify submitting
        multpile errors, the FogBugz configuration can be set in the environment.
        
        .. code-block:: bash
        
            # (Optional) Setup the environment.
            export BUGZSCOUT_URL=http://fogbugz/scoutSubmit.asp
            export BUGZSCOUT_USER=errors
            export BUGZSCOUT_PROJECT='My Project'
            export BUGZSCOUT_AREA=Errors
        
            # Submit a new error.
            bugzscout --extra 'Extra data for the case...' 'The description of the error.'
        
        Celery
        ~~~~~~
        
        The `Celery <http://celeryproject.org/>`_ extension can be used to
        asynchronously publish errors. This is the recommended pattern for using
        bugzscout in production environments.
        
        .. code-block:: python
        
            # Import celery extension.
            import bugzscout.ext.celery_app
        
            # Submit errors asynchronously.
            bugzscout.ext.celery_app.submit_error.delay(
              'The description here...',
              extra='The extra information here...')
        
        The `Celery worker
        <http://docs.celeryproject.org/en/latest/userguide/workers.html>`_ can use the
        same celery app for consuming messages.
        
        .. code-block:: bash
        
            celery worker --app=bugzscout.ext.celery_app
        
        A ``celeryconfig.py`` file on the PYTHONPATH can be used to configure the
        celery instance. For example:
        
        .. code-block:: bash
        
            export CELERY_CONFIG_MODULE=celeryconfig
            celery worker --app=bugzscout.ext.celery_app
        
        License
        -------
        BSD
        
        Authors
        -------
        Thomas Van Doren
        
Keywords: BugzScout,FogBugz
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: PyPy
