bugzscout-py

Python interface for the FogBugz BugzScout API.

Full Documentation is available on ReadTheDocs.

Installation

pip install bugzscout

Supported python versions

• 2.6, 2.7
• 3.1, 3.2, 3.3
• pypy

Getting Started

>>> import bugzscout
>>> b = bugzscout.BugzScout('http://fogbugz/scoutSubmit.asp',
                            'fb-user',
                            'the-project',
                            'the-area')
>>> b.submit_error('An error occurred of type blah', extra='Extra info')

Command Line Interface

There is a command line interface for submitting errors. To simplify submitting multiple errors, the FogBugz configuration can be set in the environment.

# (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.'

See the BugzScout Command Line Interface docs for more detail.

Celery

The Celery extension can be used to asynchronously publish errors. This is the recommended pattern for using bugzscout in production environments.

# 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 can use the same celery app for consuming messages.

celery worker --app=bugzscout.ext.celery_app

A celeryconfig.py file on the PYTHONPATH can be used to configure the celery instance. For example:

export CELERY_CONFIG_MODULE=celeryconfig
celery worker --app=bugzscout.ext.celery_app

See the Celery example in the docs for more detail.

License

BSD

Authors

Thomas Van Doren