This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!
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].

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.

## 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

## Distribution
The distribution process for Python looks like this:

$ ./
$ # Make changes to codebase.
$ # Bump version number in
$ pushd python
$ python sdist bdist_wheel --universal
$ twine upload dist/referer-parser-X.Y.Z.tar.gz
$ popd

## Copyright and license

The referer-parser Python library is copyright 2012-2016 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.



Release History

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
referer-parser-0.4.1.tar.gz (18.5 kB) Copy SHA256 Checksum SHA256 Source Jun 20, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting