Skip to main content

Tiny, zero-dependency crawler detection via regex.

Project description

is-crawler

Tiny, zero-dependency Python library that detects bots and crawlers from user-agent strings. Fast, lightweight, and ready to drop into any web app or API.

PyPI Python License Issues Stars Downloads

Docs & live demo: is-crawler.tn3w.dev

Install

pip install is-crawler

Usage

from is_crawler import is_crawler, crawler_info, crawler_has_tag

ua = "Googlebot/2.1 (+http://www.google.com/bot.html)"

is_crawler(ua)                              # True
crawler_has_tag(ua, "search-engine")        # True
crawler_has_tag(ua, ["ai-crawler", "seo"])  # False

info = crawler_info(ua)
# CrawlerInfo(url='http://www.google.com/bot.html',
#             description="Google's main web crawling bot...",
#             tags=('search-engine',))
info.url          # 'http://www.google.com/bot.html'
info.description  # "Google's main web crawling bot for search indexing"
info.tags         # ('search-engine',)

The module is also callable directly, no named import required:

import is_crawler
is_crawler("Googlebot/2.1 (+http://www.google.com/bot.html)")  # True

API reference

Function Returns Description
is_crawler(ua) bool Heuristic detection: fast, no DB
crawler_signals(ua) list[str] Which heuristic rules matched
crawler_info(ua) CrawlerInfo | None url, description, tags: DB lookup for 646 known crawlers
crawler_has_tag(ua, tag) bool tag can be str or list[str] (matches any)
crawler_name(ua) str | None Product name extracted from the UA string
crawler_version(ua) str | None Version extracted from the UA string
crawler_url(ua) str | None URL embedded in the UA string

crawler_signals returns a subset of: bot_signal, no_browser_signature, bare_compatible, known_tool, url_in_ua.

crawler_info tags: search-engine, ai-crawler, seo, social-preview, advertising, archiver, feed-reader, monitoring, scanner, academic, http-library, browser-automation.

Middleware example

from is_crawler import is_crawler, crawler_has_tag

@app.before_request
def gate():
    ua = request.headers.get("User-Agent", "")
    if crawler_has_tag(ua, "ai-crawler"):
        abort(403)        # block AI scrapers
    if is_crawler(ua):
        log_crawler(ua)   # track other bots without blocking

How it works

is_crawler / crawler_signals: five heuristic regex checks, no lookup:

  1. Bot signals: common keywords (bot, crawl, spider, scrape, ...), URL/email patterns, headless
  2. Missing browser signature: real browsers always include engine tokens like WebKit, Gecko, or Trident
  3. Bare (compatible; ...) block: classic bot pattern without OS tokens
  4. Known tools: playwright, selenium, wget, lighthouse, sqlmap, and more
  5. URL in UA: an embedded http:// or https:// URL, a near-universal bot convention

crawler_info / crawler_has_tag: pattern database loaded lazily on first call (no import-time I/O), built from monperrus/crawler-user-agents with supplemental tags. Returns url, description, and tags for 646 known crawlers.

Benchmarks

Measured on Python 3.14, Linux x86_64. Fixture corpus: 1 231 crawler UAs and 15 812 browser UAs. crawleruseragents is the crawler-user-agents PyPI package (v1.42, no caching).

is_crawler: heuristic detection (no DB)

Corpus is_crawler cua.is_crawler speedup
crawlers only 0.73 µs 60.8 µs 83×
browsers only 24.8 µs 166.6 µs
mixed 24.5 µs 158.8 µs

Purely heuristic, no DB. Crawler UAs are fast because bot_signal triggers immediately; browser UAs exhaust all five checks.

crawler_info / crawler_has_tag: DB pattern lookup

is_crawler cua equivalent speedup
crawler_info 125.9 µs 866.8 µs
crawler_has_tag 125.9 µs

crawler_has_tag delegates to crawler_info (cached); cost is independent of tag cardinality.

Formatting

pip install black isort
isort . && black .
npx prtfm

License

Apache-2.0

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

is_crawler-1.3.0.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

is_crawler-1.3.0-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file is_crawler-1.3.0.tar.gz.

File metadata

  • Download URL: is_crawler-1.3.0.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for is_crawler-1.3.0.tar.gz
Algorithm Hash digest
SHA256 b79b1e2c29872244803e4bc2bf30d7c47140493f986fa556db6f2cef41ae0d4d
MD5 d4cd22f5529bf5f6d381b89d5ac55c3f
BLAKE2b-256 ce37b364168cb1d69fc080b34e1c6fd8b5eae1ba3a7720705d0364aa977151c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for is_crawler-1.3.0.tar.gz:

Publisher: publish.yml on tn3w/is-crawler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file is_crawler-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: is_crawler-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 26.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for is_crawler-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 690b83be4295e27fa2357310f99e4d27c13b79e7fe15cb172121410d37393c1d
MD5 ab9982135e21d2d3f67b23b3071980b3
BLAKE2b-256 015ea8b9656bec61982dad20ecd670ddc073b9cbbb953bd6551e53cc15339ae4

See more details on using hashes here.

Provenance

The following attestation bundles were made for is_crawler-1.3.0-py3-none-any.whl:

Publisher: publish.yml on tn3w/is-crawler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page