ua-parser-up2date


Nameua-parser-up2date JSON
Version 0.18.1 PyPI version JSON
download
home_page
SummaryPython port of Browserscope's user agent parser
upload_time2023-08-07 22:51:54
maintainer
docs_urlNone
author
requires_python>=3.9
licenseApache 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            uap-python
==========

An **up to date** python implementation of the UA Parser (https://github.com/ua-parser,
formerly https://github.com/tobie/ua-parser)

Build Status
------------

.. image:: https://github.com/ua-parser/uap-python/actions/workflows/ci.yml/badge.svg
   :alt: CI on the master branch


Installing
----------

Install via pip
~~~~~~~~~~~~~~~

Just run:

.. code-block:: sh

    $ pip install ua-parser-up2date

Manual install
~~~~~~~~~~~~~~

In the top-level directory run:

.. code-block:: sh

    $ python setup.py install

Change Log
---------------
Because this repo is mostly a python wrapper for the User Agent String Parser repo (https://github.com/ua-parser/uap-core), the changes made to this repo are best described by the update diffs in that project. Please see the diffs for this submodule (https://github.com/ua-parser/uap-core/releases) for a list of what has changed between versions of this package.

Getting Started
---------------

Retrieve data on a user-agent string
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    >>> from ua_parser import user_agent_parser
    >>> import pprint
    >>> pp = pprint.PrettyPrinter(indent=4)
    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'
    >>> parsed_string = user_agent_parser.Parse(ua_string)
    >>> pp.pprint(parsed_string)
    {   'device': {'brand': 'Apple', 'family': 'Mac', 'model': 'Mac'},
        'os': {   'family': 'Mac OS X',
                  'major': '10',
                  'minor': '9',
                  'patch': '4',
                  'patch_minor': None},
        'string': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) '
                  'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 '
                  'Safari/537.36',
        'user_agent': {   'family': 'Chrome',
                          'major': '41',
                          'minor': '0',
                          'patch': '2272'}}

Extract browser data from user-agent string
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    >>> from ua_parser import user_agent_parser
    >>> import pprint
    >>> pp = pprint.PrettyPrinter(indent=4)
    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'
    >>> parsed_string = user_agent_parser.ParseUserAgent(ua_string)
    >>> pp.pprint(parsed_string)
    {'family': 'Chrome', 'major': '41', 'minor': '0', 'patch': '2272'}

..

    ⚠️Before 0.15, the convenience parsers (``ParseUserAgent``,
    ``ParseOs``, and ``ParseDevice``) were not cached, which could
    result in degraded performances when parsing large amounts of
    identical user-agents (which might occur for real-world datasets).

    For these versions (up to 0.10 included), prefer using ``Parse``
    and extracting the sub-component you need from the resulting
    dictionary.

Extract OS information from user-agent string
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    >>> from ua_parser import user_agent_parser
    >>> import pprint
    >>> pp = pprint.PrettyPrinter(indent=4)
    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'
    >>> parsed_string = user_agent_parser.ParseOS(ua_string)
    >>> pp.pprint(parsed_string)
    {   'family': 'Mac OS X',
        'major': '10',
        'minor': '9',
        'patch': '4',
        'patch_minor': None}

Extract Device information from user-agent string
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    >>> from ua_parser import user_agent_parser
    >>> import pprint
    >>> pp = pprint.PrettyPrinter(indent=4)
    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'
    >>> parsed_string = user_agent_parser.ParseDevice(ua_string)
    >>> pp.pprint(parsed_string)
    {'brand': 'Apple', 'family': 'Mac', 'model': 'Mac'}

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ua-parser-up2date",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "masklinn <uap@masklinn.net>",
    "keywords": "",
    "author": "",
    "author_email": "Stephen Lamm <slamm@google.com>, PBS <no-reply@pbs.org>, Selwin Ong <selwin.ong@gmail.com>, Matt Robenolt <matt@ydekproductions.com>, Lindsey Simon <lsimon@commoner.com>",
    "download_url": "https://files.pythonhosted.org/packages/d8/67/0d8d5295303d699bd026daa14d94b6c55bae138763f1ee5ca8ea5fcb3c7e/ua-parser-up2date-0.18.1.tar.gz",
    "platform": null,
    "description": "uap-python\n==========\n\nAn **up to date** python implementation of the UA Parser (https://github.com/ua-parser,\nformerly https://github.com/tobie/ua-parser)\n\nBuild Status\n------------\n\n.. image:: https://github.com/ua-parser/uap-python/actions/workflows/ci.yml/badge.svg\n   :alt: CI on the master branch\n\n\nInstalling\n----------\n\nInstall via pip\n~~~~~~~~~~~~~~~\n\nJust run:\n\n.. code-block:: sh\n\n    $ pip install ua-parser-up2date\n\nManual install\n~~~~~~~~~~~~~~\n\nIn the top-level directory run:\n\n.. code-block:: sh\n\n    $ python setup.py install\n\nChange Log\n---------------\nBecause this repo is mostly a python wrapper for the User Agent String Parser repo (https://github.com/ua-parser/uap-core), the changes made to this repo are best described by the update diffs in that project. Please see the diffs for this submodule (https://github.com/ua-parser/uap-core/releases) for a list of what has changed between versions of this package.\n\nGetting Started\n---------------\n\nRetrieve data on a user-agent string\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    >>> from ua_parser import user_agent_parser\n    >>> import pprint\n    >>> pp = pprint.PrettyPrinter(indent=4)\n    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'\n    >>> parsed_string = user_agent_parser.Parse(ua_string)\n    >>> pp.pprint(parsed_string)\n    {   'device': {'brand': 'Apple', 'family': 'Mac', 'model': 'Mac'},\n        'os': {   'family': 'Mac OS X',\n                  'major': '10',\n                  'minor': '9',\n                  'patch': '4',\n                  'patch_minor': None},\n        'string': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) '\n                  'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 '\n                  'Safari/537.36',\n        'user_agent': {   'family': 'Chrome',\n                          'major': '41',\n                          'minor': '0',\n                          'patch': '2272'}}\n\nExtract browser data from user-agent string\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    >>> from ua_parser import user_agent_parser\n    >>> import pprint\n    >>> pp = pprint.PrettyPrinter(indent=4)\n    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'\n    >>> parsed_string = user_agent_parser.ParseUserAgent(ua_string)\n    >>> pp.pprint(parsed_string)\n    {'family': 'Chrome', 'major': '41', 'minor': '0', 'patch': '2272'}\n\n..\n\n    \u26a0\ufe0fBefore 0.15, the convenience parsers (``ParseUserAgent``,\n    ``ParseOs``, and ``ParseDevice``) were not cached, which could\n    result in degraded performances when parsing large amounts of\n    identical user-agents (which might occur for real-world datasets).\n\n    For these versions (up to 0.10 included), prefer using ``Parse``\n    and extracting the sub-component you need from the resulting\n    dictionary.\n\nExtract OS information from user-agent string\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    >>> from ua_parser import user_agent_parser\n    >>> import pprint\n    >>> pp = pprint.PrettyPrinter(indent=4)\n    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'\n    >>> parsed_string = user_agent_parser.ParseOS(ua_string)\n    >>> pp.pprint(parsed_string)\n    {   'family': 'Mac OS X',\n        'major': '10',\n        'minor': '9',\n        'patch': '4',\n        'patch_minor': None}\n\nExtract Device information from user-agent string\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n    >>> from ua_parser import user_agent_parser\n    >>> import pprint\n    >>> pp = pprint.PrettyPrinter(indent=4)\n    >>> ua_string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.104 Safari/537.36'\n    >>> parsed_string = user_agent_parser.ParseDevice(ua_string)\n    >>> pp.pprint(parsed_string)\n    {'brand': 'Apple', 'family': 'Mac', 'model': 'Mac'}\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "Python port of Browserscope's user agent parser",
    "version": "0.18.1",
    "project_urls": {
        "repository": "https://github.com/robd003/uap-python-up2date"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d8670d8d5295303d699bd026daa14d94b6c55bae138763f1ee5ca8ea5fcb3c7e",
                "md5": "d834bb66346c68df5e8057883b89e741",
                "sha256": "a8a74f4cc2109b20d9fbf40427b2e275fa061c17e65276bb8e389d9cd73d6223"
            },
            "downloads": -1,
            "filename": "ua-parser-up2date-0.18.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d834bb66346c68df5e8057883b89e741",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 820123,
            "upload_time": "2023-08-07T22:51:54",
            "upload_time_iso_8601": "2023-08-07T22:51:54.768787Z",
            "url": "https://files.pythonhosted.org/packages/d8/67/0d8d5295303d699bd026daa14d94b6c55bae138763f1ee5ca8ea5fcb3c7e/ua-parser-up2date-0.18.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-07 22:51:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "robd003",
    "github_project": "uap-python-up2date",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "ua-parser-up2date"
}
        
Elapsed time: 0.12939s