Welcome to BrowserMob Proxy’s documentation!

Python client for the BrowserMob Proxy 2.0 REST API.

How to install

BrowserMob Proxy is available on PyPI, so you can install it with pip:

$ pip install browsermob-proxy

Or with easy_install:

$ easy_install browsermob-proxy

Or by cloning the repo from GitHub:

$ git clone git://github.com/AutomatedTester/browsermob-proxy-py.git

Then install it by running:

$ python setup.py install

How to use with selenium-webdriver


from browsermobproxy import Server
server = Server("path/to/browsermob-proxy")
proxy = server.create_proxy()

from selenium import webdriver
profile  = webdriver.FirefoxProfile()
driver = webdriver.Firefox(firefox_profile=profile)

proxy.har # returns a HAR JSON blob


How to Contribute

Getting Started

  • Fork the repository on GitHub - well... duh :P
  • Create a virtualenv: virtualenv venv
  • Activate the virtualenv: . venv/bin/activate
  • Install the package in develop mode: python setup.py develop
  • Install requirements: pip install -r requirements.txt
  • Run the tests to check that everything was successful: `py.test tests

Making Changes

  • Create a topic branch from where you want to base your work. * This is usually the master branch. * Only target release branches if you are certain your fix must be on that


    • To quickly create a topic branch based on master; git checkout -b /my_contribution master. Please avoid working directly on the master branch.
  • Make commits of logical units.

  • Check for unnecessary whitespace with git diff –check before committing.

  • Make sure you have added the necessary tests for your changes.

  • Run _all_ the tests to assure nothing else was accidentally broken.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the main repository
  • After feedback has been given we expect responses within two weeks. After two weeks will may close the pull request if it isn’t showing any activity


Indices and tables