Django HTTP Proxy¶

Requirements¶

Django HTTP Proxy should be compatible with any Python 2.x version from 2.5 and up and a relatively recent version of Django. It is compatible with Django 1.7.

Installation¶

The easiest way to install the latest version of Django HTTP Proxy is using pip:

$ pip install django-http-proxy

Alternatively, you can manually download the package from the Python Package Index or from the Github repository.

Next, you need to add “httpproxy” to the INSTALLED_APPS list in your Django settings module (typically settings.py):

INSTALLED_APPS = (
    ...
    'httpproxy',
)

Finally, install the database tables:

$ python manage.py syncdb

Configuration¶

The core of Django HTTP Proxy is a class-based Django view, httpproxy.views.HttpProxy.

To use Django HTTP Proxy, you create an entry in your urls.py that forwards requests to the HttpProxy view class, e.g.:

from httpproxy.views import HttpProxy

urlpatterns += patterns('',
    (r'^proxy/(?P<url>.*)$',
        HttpProxy.as_view(base_url='http://www.python.org/')),
)

Given the above url config, request matching /proxy/<any-url> will be handled by the configured HttpProxy view instance and forwarded to http://www.python.org/<any-url>.

PROXY_BASE_URL = 'http://www.python.org/'

from django.conf import settings
from httpproxy.views import HttpProxy

urlpatterns += patterns('',
    (r'^proxy/(?P<url>.*)$',
        HttpProxy.as_view(base_url=settings.PROXY_BASE_URL)),
)

0.4.3 (2016-02-10)¶

• Merged pull request from Ihor Kucher (thanks!): add support of post requests & update headers setting

0.4.2 (2016-02-10)¶

• Merged pull request from Don Naegely (thanks!): Generate missing migrations

0.4.1¶

• Python 3 compatibility (requires Django >= 1.6)
• Fix duplicated forward slashes in urls

0.4¶

• Migration from Bitbucket (Mercurial) to Github
• Refactored main view using Django class-based views (see HttpProxy)
• Removed basic authentication support (PROXY_USER and PROXY_PASSWORD); may be added back later on.
• Finally merged back Django 1.6 fixes by Petr Dlouhý (thanks!)
• Merged pull request from Garrett Seward (thanks!)
• Added Django 1.7 compatibility
• Added database migrations (Django 1.7 and higher only)
• Updated and improvement the documentation (including API documentation)
• Added an example project for reference
• Using urllib2 instead of httplib2
• Using setuptools instead of distutils
• Using versioneer2 for package versioning
• Removed some unused imports and did some further code cleanup

0.3.2¶

• Limited display of request querystring in admin screen to 50 characters

0.3.1¶

• Fixed 250 character limitation for querystring in Recorded Request (issue #2)
• Added new Request Parameter model; requires ./manage.py reset httpproxy && ./manage.py syncdb

0.3¶

• Fixed Python 2.5 support by removing use of __package__
• Implemented request path “normalization”, fixing record and playback if the proxy is URL-configured anywhere other than directly in the root.
• Added experimental PROXY_REWRITE_RESPONSES settings to fix paths to resources (images, javascript, etc) on the same domain if httproxy is not configured at the root.

0.2.2¶

• Removed print statement I accidentally left behind.

0.2.1¶

• Fixed issue #1; Unsupported content types are now silently ignored.
• Added PROXY_IGNORE_UNSUPPORTED setting to control the behavior for handling unsupported responses.

0.2¶

• Added recording and playback functionality
• Improved handling of httpproxy-specific settings
• Started using Sphinx for documentation

0.1¶

• Initial release
• Basic HTTP proxy functionality based on a blog post by Will Larson

Development setup¶

To set up the project for local development:

$ git clone https://github.com/yvandermeer/django-http-proxy.git
$ mkvirtualenv django-http-proxy
$ pip install -r requirements.txt
$ python example/manage.py syncdb
$ python example/manage.py runserver

Finally, point your browser to http://127.0.0.1:8000/python/ and you should see something that resembles what you see on http://www.python.org/.

Building the documentation¶

Documention is provided in Sphinx format in the docs subdirectory. To build the HTML version of the documentation yourself:

$ cd docs
$ make html