Skip to main content


Project description

# referer-parser Python library

This is the Python implementation of [referer-parser] [referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.

The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml] (converted to a `referers.json` file,
see below).

The Python version of referer-parser is maintained by [Don Spaulding] [donspaulding].

## Installation

$ pip install referer_parser

## Usage

Create a new instance of a Referer object by passing in the url you want to parse:

from referer_parser import Referer

referer_url = ''

r = Referer(referer_url)

The `r` variable now holds a Referer instance. The important attributes are:

print(r.known) # True
print(r.referer) # 'Google'
print(r.medium) # 'search'
print(r.search_parameter) # 'q'
print(r.search_term) # 'gateway oracle cards denise linn'
print(r.uri) # ParseResult(scheme='http', netloc='', path='/search', params='', query='q=gateway+oracle+cards+denise+linn&hl=en&client=safari', fragment='')

Optionally, pass in the current URL as well, to handle internal referers

from referer_parser import Referer

referer_url = ''
curr_url = ''

r = Referer(referer_url, curr_url)

The attributes would be

print(r.known) # True
print(r.referer) # None
print(r.medium) # 'internal'
print(r.search_parameter) # None
print(r.search_term) # None
print(r.uri) # ParseResult(scheme='http', netloc='', path='/about/team', params='', query='', fragment='')

The `uri` attribute is an instance of ParseResult from the standard library's `urlparse` module.

## referers.json

Unlike the other ports, the Python version of referer-parser uses a `referers.json` file, generated from the main `referers.yml` file. This is for two reasons:

1. Python's standard library includes a JSON parser but not a YAML parser
2. Loading from JSON in Python is significantly faster than loading from YAML

To support the `referers.json` file, the distribution process for Python looks like this:

$ ./
$ cd python/referer_parser && python
$ python sdist bdist_wininst upload

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## Copyright and license

The referer-parser Python library is copyright 2012-2013 Don Spaulding.

Licensed under the [Apache License, Version 2.0] [license] (the "License");
you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.




Project details

Release history Release notifications

History Node


History Node


This version
History Node


History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
referer-parser-0.3.1.macosx-10.9-x86_64.exe (92.1 kB) Copy SHA256 hash SHA256 Windows Installer any Jul 28, 2014
referer-parser-0.3.1.tar.gz (19.0 kB) Copy SHA256 hash SHA256 Source None Jul 28, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page