package documentation

Welcome to the burpa API documentation!

Example

>>> from burpa import Burpa
>>> burp = Burpa(api_url="localhost")
>>> burp.scan('http://mysite.com', report_output_dir='.')
See Also
burpa.Burpa
Module __version__ Undocumented
Module __main__ Undocumented
Module _api_base No module docstring; 1/1 class documented
Module _burp_commander Undocumented
Module _burp_rest_api_client Undocumented
Module _burpa No module docstring; 0/2 constant, 0/2 function, 1/1 class documented
Module _error Undocumented
Module _utils No module docstring; 0/1 variable, 5/11 functions documented

From __init__.py:

Class Burpa High level interface for the Burp Suite Security Tool.
Class BurpCommander Interface for the Burp Suite Official REST API, based on ruby code burpcommander.
Class BurpRestApiClient Interface for the third party extension burp-rest-api.
Exception BurpaError Exception raised when there is an error in a burpa command.