Modernize as user-agents-ng 3.0.0

- Migrate packaging from setup.py to pyproject.toml (name: user-agents-ng)
- Drop Python 2 support (remove compat.py and __unicode__); require Python 3.9+
- Add type hints throughout and a py.typed marker
- Replace dead Travis config with GitHub Actions CI (Linux + Windows, Python 3.9-3.14)
- Rewrite README as a maintained drop-in successor to user-agents
- Bump version to 3.0.0

All 55 tests pass on Python 3.14 with ua-parser 1.0.2.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Author: SAKMZ

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .
+
+      - name: Run tests
+        run: python -m unittest -v user_agents.tests

.travis.yml

@@ -1,28 +1,46 @@
-Python User Agents
-==================
+# user-agents-ng
 
-`user_agents` is a Python library that provides an easy way to identify/detect devices like mobile phones, tablets and their capabilities by parsing (browser/HTTP) user agent strings. The goal is to reliably detect whether:
+[![CI](https://github.com/SAKMZ/python-user-agents/actions/workflows/ci.yml/badge.svg)](https://github.com/SAKMZ/python-user-agents/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/user-agents-ng.svg)](https://pypi.org/project/user-agents-ng/)
+
+> **A maintained, drop-in successor to [`user-agents`](https://pypi.org/project/user-agents/).**
+> The original [`selwin/python-user-agents`](https://github.com/selwin/python-user-agents)
+> has had no release since 2020. `user-agents-ng` picks up where it left off:
+> modern packaging, type hints, and tested support for Python 3.9–3.14.
+> **The import stays the same (`from user_agents import parse`) — just change what you `pip install`.**
+
+`user_agents` is a Python library that provides an easy way to identify/detect
+devices like mobile phones, tablets and their capabilities by parsing
+(browser/HTTP) user agent strings. The goal is to reliably detect whether:
 
 * User agent is a mobile, tablet or PC based device
 * User agent has touch capabilities (has touch screen)
 
-`user_agents` relies on the excellent [ua-parser](https://github.com/ua-parser/uap-python) to do the actual parsing of the raw user agent string.
+`user_agents` relies on the excellent [ua-parser](https://github.com/ua-parser/uap-python)
+to do the actual parsing of the raw user agent string.
+
+## Installation
 
-Installation
-------------
+`user-agents-ng` is hosted on [PyPI](https://pypi.org/project/user-agents-ng/) and can be installed with:
 
-![Build status](https://secure.travis-ci.org/selwin/python-user-agents.png)
+    pip install user-agents-ng
 
-`user-agents` is hosted on [PyPI](http://pypi.python.org/pypi/user-agents/) and can be installed as such:
+### Migrating from `user-agents`
 
-    pip install pyyaml ua-parser user-agents
+`user-agents-ng` is a drop-in replacement. Swap the dependency and your code
+keeps working unchanged:
 
-Alternatively, you can also get the latest source code from [Github](https://github.com/selwin/python-user-agents) and install it manually.
+    pip uninstall user-agents
+    pip install user-agents-ng
 
-Usage
------
+```python
+from user_agents import parse  # <- unchanged
+```
 
-Various basic information that can help you identify visitors can be accessed `browser`, `device` and `os` attributes. For example:
+## Usage
+
+Various basic information that can help you identify visitors can be accessed via the
+`browser`, `device` and `os` attributes. For example:
 
 ```python
 from user_agents import parse
@@ -32,19 +50,19 @@ ua_string = 'Mozilla/5.0 (iPhone; CPU iPhone OS 5_1 like Mac OS X) AppleWebKit/5
 user_agent = parse(ua_string)
 
 # Accessing user agent's browser attributes
-user_agent.browser  # returns Browser(family=u'Mobile Safari', version=(5, 1), version_string='5.1')
+user_agent.browser  # returns Browser(family='Mobile Safari', version=(5, 1), version_string='5.1')
 user_agent.browser.family  # returns 'Mobile Safari'
 user_agent.browser.version  # returns (5, 1)
 user_agent.browser.version_string   # returns '5.1'
 
 # Accessing user agent's operating system properties
-user_agent.os  # returns OperatingSystem(family=u'iOS', version=(5, 1), version_string='5.1')
+user_agent.os  # returns OperatingSystem(family='iOS', version=(5, 1), version_string='5.1')
 user_agent.os.family  # returns 'iOS'
 user_agent.os.version  # returns (5, 1)
 user_agent.os.version_string  # returns '5.1'
 
 # Accessing user agent's device properties
-user_agent.device  # returns Device(family=u'iPhone', brand=u'Apple', model=u'iPhone')
+user_agent.device  # returns Device(family='iPhone', brand='Apple', model='iPhone')
 user_agent.device.family  # returns 'iPhone'
 user_agent.device.brand # returns 'Apple'
 user_agent.device.model # returns 'iPhone'
@@ -53,7 +71,10 @@ user_agent.device.model # returns 'iPhone'
 str(user_agent) # returns "iPhone / iOS 5.1 / Mobile Safari 5.1"
 ```
 
-`user_agents` also expose a few other more "sophisticated" attributes that are derived from one or more basic attributes defined above. As for now, these attributes should correctly identify popular platforms/devices, pull requests to support smaller ones are always welcome.
+`user_agents` also exposes a few other more "sophisticated" attributes that are
+derived from one or more basic attributes defined above. These attributes should
+correctly identify popular platforms/devices; pull requests to support smaller
+ones are always welcome.
 
 Currently these attributes are supported:
 
@@ -88,26 +109,6 @@ user_agent.is_pc # returns False
 user_agent.is_bot # returns False
 str(user_agent) # returns "Samsung GT-I9300 / Android 4.0.4 / Android 4.0.4"
 
-# iPad's user agent string
-ua_string = 'Mozilla/5.0(iPad; U; CPU iPhone OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B314 Safari/531.21.10'
-user_agent = parse(ua_string)
-user_agent.is_mobile # returns False
-user_agent.is_tablet # returns True
-user_agent.is_touch_capable # returns True
-user_agent.is_pc # returns False
-user_agent.is_bot # returns False
-str(user_agent) # returns "iPad / iOS 3.2 / Mobile Safari 4.0.4"
-
-# Kindle Fire's user agent string
-ua_string = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_3; en-us; Silk/1.1.0-80) AppleWebKit/533.16 (KHTML, like Gecko) Version/5.0 Safari/533.16 Silk-Accelerated=true'
-user_agent = parse(ua_string)
-user_agent.is_mobile # returns False
-user_agent.is_tablet # returns True
-user_agent.is_touch_capable # returns True
-user_agent.is_pc # returns False
-user_agent.is_bot # returns False
-str(user_agent) # returns "Kindle / Android / Amazon Silk 1.1.0-80"
-
 # Touch capable Windows 8 device
 ua_string = 'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; Trident/6.0; Touch)'
 user_agent = parse(ua_string)
@@ -119,61 +120,24 @@ user_agent.is_bot # returns False
 str(user_agent) # returns "PC / Windows 8 / IE 10"
 ```
 
-Running Tests
--------------
-
-    python -m unittest discover
-
-Changelog
----------
-### Version 2.2.0 (2020-08-23)
-* `ua-parser` >= 0.10.0 is required. Thanks @jnozsc!
-* Added `get_device()`, `get_os()` and `get_browser()` instance methods
-to `UserAgent`. Thanks @rodrigondec!
-
-### Version 2.1 (2020-02-08)
-
-* `python-user-agents` now require `ua-parser>=0.9.0`. Thanks @jnozsc!
-* Properly detect Chrome Mobile browser families. Thanks @jnozsc!
-
-### Version 2.0 (2019-04-07)
-
-* `python-user-agents` now require `ua-parser>=0.8.0`. Thanks @IMDagger!
-
-### Version 1.1
-
-* Fixes packaging issue
-
-### Version 1.0
-
-* Adds compatibility with `ua-parser` 0.4.0
-* Access to more device information in `user_agent.device.brand` and `user_agent.device.model`
-
-### Version 0.3.2
-
-* Better mobile detection
-* Better PC detection
-
-### Version 0.3.1
-
-* user\_agent.is\_mobile returns True when mobile spider is detected
-
-### Version 0.3.0
-
-* Added **str**/**unicode** methods for convenience of pretty string
+## Running Tests
 
-### Version 0.2.0
+    python -m unittest user_agents.tests
 
-* Fixed errors when running against newer versions if ua-parser
-* Support for Python 3
+## Changelog
 
-### Version 0.1.1
+### Version 3.0.0
 
-* Added `is_bot` property
-* Symbian OS devices are now detected as a mobile device
+* Released as `user-agents-ng`, a maintained successor to `user-agents`.
+* Tested support for Python 3.9–3.14; dropped Python 2.
+* Migrated packaging to `pyproject.toml`; added `py.typed` and type hints.
+* Replaced Travis CI with GitHub Actions (Linux + Windows).
 
-### Version 0.1
+For the pre-3.0 history, see the original
+[project changelog](https://github.com/selwin/python-user-agents).
 
-* Initial release
+## Credits
 
-Developed by the cool guys at [Stamps](http://stamps.co.id).
+Originally created by Selwin Ong and the team at
+[Stamps](http://stamps.co.id). Maintained as `user-agents-ng` by
+[Saif Ali](https://github.com/SAKMZ). Licensed under the MIT License.

MANIFEST

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "user-agents-ng"
+version = "3.0.0"
+description = "A maintained successor to user-agents: identify devices (phones, tablets) and their capabilities by parsing browser user agent strings."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE.txt"]
+authors = [
+    { name = "Selwin Ong" },
+]
+maintainers = [
+    { name = "Saif Ali", email = "saifalimz@gmail.com" },
+]
+keywords = ["user agent", "user-agents", "browser", "device", "detection", "parser", "mobile", "tablet", "bot"]
+dependencies = [
+    "ua-parser>=0.10.0",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://github.com/SAKMZ/python-user-agents"
+Repository = "https://github.com/SAKMZ/python-user-agents"
+Issues = "https://github.com/SAKMZ/python-user-agents/issues"
+
+[tool.setuptools]
+packages = ["user_agents"]
+
+[tool.setuptools.package-data]
+user_agents = ["devices.json", "py.typed"]

MANIFEST.in

@@ -1,3 +1,5 @@
-VERSION = (2, 2, 0)
+VERSION = (3, 0, 0)
 
-from .parsers import parse
+from .parsers import UserAgent, parse
+
+__all__ = ['UserAgent', 'parse']