pyramid_useragent

HTTP User-Agent parser for Pyramid


Keywords
web, wsgi, pylons, pyramid, user-agent, pyramid-framework
License
Other
Install
pip install pyramid_useragent==0.3

Documentation

pyramid_useragent

Provides an HTTP User-Agent parser and classifier for the Pyramid web framework.

Tests on CircleCI Python version on PyPI Documentation on ReadTheDocs

Code: https://github.com/pior/pyramid_useragent

Setup

Once pyramid_useragent is installed, you typically use the config.include mechanism to include it into your Pyramid project's configuration. In your Pyramid project's __init__.py:

config = Configurator(.....)
config.include('pyramid_useragent')

Alternately, instead of using the Configurator's include method, you can activate Pyramid by changing your application's .ini file, use the following line:

pyramid.includes = pyramid_useragent

Usage

def demo(request):

    client = request.user_agent_classified

    if client.is_mobile or client.is_tablet:
        return "Download our mobile app!"

    if client.is_bot:
        return "Are you human? I'am human."

    ua = request.user_agent_parsed

    if ua.maincomponent.name == 'Links':
        return "Did you REALLY use Links?"

    if 'AdobeAIR' in ua.components:
        if ua.components['AdobeAIR'].version == '3.9.0.1210':
            return "Much unsecure, so flaws"

    if ua.maincomponent.name == "Mozilla":
        return "This is supposed to describe your platform: %s" % (
            '; '.join(ua.maincomponent.comments))

    return [c.name for c in ua.components.values()]

Tests

For development, this project uses a tool called DevBuddy.

To install DevBuddy, go to the install page on Github Once installed, you should be able to run bud up to setup your development environment.

If you don't want to use DevBuddy, take a look at the file dev.yml to know how the project is setup, linted, tested, released.

$ bud test

Documentation

pip install -e .[docs]
cd docs
make html

Release

Make sure you run the tests just before:

$ bud test

Create a new release:

$ bud release 0.4.0

Publish the release:

$ bud publish