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
Metadata
Release files for bugzscout 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bugzscout-0.0.1.tar.gz | 5.3 kB | Without provenance | Details for bugzscout-0.0.1.tar.gz |
Release files / bugzscout-0.0.1.tar.gz
| Download URL | bugzscout-0.0.1.tar.gz |
|---|---|
| Size | 5.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
50aaf515c3751c7af16736688cdfd7aeb74d326d898ac9ebe96d4930b4756e19
|
|
BLAKE2b-256 checksum How to use checksums |
a2aca4c499a8a08ed5471862f0ca13e19b493bc61ba3d9aad1aebc3bfe16a5b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for bugzscout 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.