openbrand 0.1.0__tar.gz

openbrand-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

openbrand-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Cass
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openbrand-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: openbrand
+Version: 0.1.0
+Summary: Extract brand assets (logos, colors, backdrops) from any website. A dependency-light Python alternative to the openbrand npm package.
+Project-URL: Homepage, https://github.com/cassidyhhaas/openbrand-py
+Project-URL: Repository, https://github.com/cassidyhhaas/openbrand-py
+Project-URL: Issues, https://github.com/cassidyhhaas/openbrand-py/issues
+Project-URL: Changelog, https://github.com/cassidyhhaas/openbrand-py/releases
+Author-email: Cass <cassidyhhaas@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: brand,color-extraction,favicon,logo,metadata,scraping,web
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: pillow>=10.0.0
+Provides-Extra: async
+Requires-Dist: httpx>=0.27.0; extra == 'async'
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# openbrand
+
+Extract brand assets — **logos, colors, backdrops, and brand name** — from any
+website URL. A dependency-light Python port of the open-source
+[`openbrand`](https://github.com/ethanjyx/OpenBrand) npm package, built to
+remove any coupling to the npm registry.
+
+**One required dependency:** [Pillow](https://python-pillow.org/) (image
+decoding for color quantization). Everything else is the Python standard
+library. `httpx` is an optional extra for the native-async backend.
+
+## Install
+
+```bash
+pip install openbrand
+# or, with the native-async backend (httpx):
+pip install "openbrand[async]"
+```
+
+Requires Python 3.12+.
+
+## Library use
+
+```python
+from openbrand import extract_brand_assets
+
+result = extract_brand_assets("https://stripe.com")
+if result.ok:
+    assets = result.data
+    print(assets.brand_name)              # "Stripe"
+    for logo in assets.logos:
+        print(logo.type, logo.url)
+    for color in assets.colors:
+        print(color.usage, color.hex)     # primary / secondary / accent
+    for backdrop in assets.backdrops:
+        print(backdrop.url)
+else:
+    print(result.error.code, result.error.message)
+```
+
+`extract_brand_assets` never raises on network/HTTP failures — they come back
+via `result.ok == False` with a classified `result.error.code` (one of
+`ACCESS_BLOCKED`, `NOT_FOUND`, `SERVER_ERROR`, `NETWORK_ERROR`,
+`EMPTY_CONTENT`).
+
+## Async use (FastAPI, asyncio, …)
+
+```python
+from openbrand import aextract_brand_assets
+
+result = await aextract_brand_assets("https://stripe.com")
+```
+
+Drops cleanly into any event loop. Two backends, same return value:
+
+- **Default** (no extras): runs the sync pipeline on a worker thread via
+  `asyncio.to_thread`. Zero extra deps, never blocks the event loop, no
+  in-extraction concurrency.
+- **`pip install "openbrand[async]"`**: switches to a native async backend
+  powered by `httpx` that fetches the page and pre-warms all candidate-image
+  bytes **concurrently**, then runs the heuristics against cache. Measurably
+  faster on sites with many logo candidates.
+
+## CLI
+
+```bash
+openbrand https://stripe.com              # pretty JSON
+openbrand https://stripe.com --indent 0   # compact, single line
+python -m openbrand https://stripe.com    # module form
+```
+
+Exits non-zero when extraction fails.
+
+## What it extracts
+
+| Asset | Sources |
+|-------|---------|
+| **brand_name** | `og:site_name` → `application-name` → header/nav logo alt → `<title>` segment → domain |
+| **logos** | favicons, apple-touch-icons, `<img>`, inline `<svg>` (serialized to a `data:` URI), ranked by a two-pass header/nav heuristic; dimensions probed per image |
+| **colors** | declared (`theme-color`, `msapplication-TileColor`, `manifest.json`) + saturation-weighted quantization of the logo imagery; capped at 3 with `primary`/`secondary`/`accent` roles |
+| **backdrops** | `og:image`, CSS `background-image`, hero `<img>` (excludes `data:` and `.svg`) |
+
+## Links
+
+- Source: [github.com/cassidyhhaas/openbrand-py](https://github.com/cassidyhhaas/openbrand-py)
+- Issues: [github.com/cassidyhhaas/openbrand-py/issues](https://github.com/cassidyhhaas/openbrand-py/issues)
+- Contributing & release process: [CONTRIBUTING.md](https://github.com/cassidyhhaas/openbrand-py/blob/main/CONTRIBUTING.md)
+
+## License
+
+MIT (matching the upstream `openbrand` package).

openbrand-0.1.0/README.md

@@ -0,0 +1,91 @@
+# openbrand
+
+Extract brand assets — **logos, colors, backdrops, and brand name** — from any
+website URL. A dependency-light Python port of the open-source
+[`openbrand`](https://github.com/ethanjyx/OpenBrand) npm package, built to
+remove any coupling to the npm registry.
+
+**One required dependency:** [Pillow](https://python-pillow.org/) (image
+decoding for color quantization). Everything else is the Python standard
+library. `httpx` is an optional extra for the native-async backend.
+
+## Install
+
+```bash
+pip install openbrand
+# or, with the native-async backend (httpx):
+pip install "openbrand[async]"
+```
+
+Requires Python 3.12+.
+
+## Library use
+
+```python
+from openbrand import extract_brand_assets
+
+result = extract_brand_assets("https://stripe.com")
+if result.ok:
+    assets = result.data
+    print(assets.brand_name)              # "Stripe"
+    for logo in assets.logos:
+        print(logo.type, logo.url)
+    for color in assets.colors:
+        print(color.usage, color.hex)     # primary / secondary / accent
+    for backdrop in assets.backdrops:
+        print(backdrop.url)
+else:
+    print(result.error.code, result.error.message)
+```
+
+`extract_brand_assets` never raises on network/HTTP failures — they come back
+via `result.ok == False` with a classified `result.error.code` (one of
+`ACCESS_BLOCKED`, `NOT_FOUND`, `SERVER_ERROR`, `NETWORK_ERROR`,
+`EMPTY_CONTENT`).
+
+## Async use (FastAPI, asyncio, …)
+
+```python
+from openbrand import aextract_brand_assets
+
+result = await aextract_brand_assets("https://stripe.com")
+```
+
+Drops cleanly into any event loop. Two backends, same return value:
+
+- **Default** (no extras): runs the sync pipeline on a worker thread via
+  `asyncio.to_thread`. Zero extra deps, never blocks the event loop, no
+  in-extraction concurrency.
+- **`pip install "openbrand[async]"`**: switches to a native async backend
+  powered by `httpx` that fetches the page and pre-warms all candidate-image
+  bytes **concurrently**, then runs the heuristics against cache. Measurably
+  faster on sites with many logo candidates.
+
+## CLI
+
+```bash
+openbrand https://stripe.com              # pretty JSON
+openbrand https://stripe.com --indent 0   # compact, single line
+python -m openbrand https://stripe.com    # module form
+```
+
+Exits non-zero when extraction fails.
+
+## What it extracts
+
+| Asset | Sources |
+|-------|---------|
+| **brand_name** | `og:site_name` → `application-name` → header/nav logo alt → `<title>` segment → domain |
+| **logos** | favicons, apple-touch-icons, `<img>`, inline `<svg>` (serialized to a `data:` URI), ranked by a two-pass header/nav heuristic; dimensions probed per image |
+| **colors** | declared (`theme-color`, `msapplication-TileColor`, `manifest.json`) + saturation-weighted quantization of the logo imagery; capped at 3 with `primary`/`secondary`/`accent` roles |
+| **backdrops** | `og:image`, CSS `background-image`, hero `<img>` (excludes `data:` and `.svg`) |
+
+## Links
+
+- Source: [github.com/cassidyhhaas/openbrand-py](https://github.com/cassidyhhaas/openbrand-py)
+- Issues: [github.com/cassidyhhaas/openbrand-py/issues](https://github.com/cassidyhhaas/openbrand-py/issues)
+- Contributing & release process: [CONTRIBUTING.md](https://github.com/cassidyhhaas/openbrand-py/blob/main/CONTRIBUTING.md)
+
+## License
+
+MIT (matching the upstream `openbrand` package).

openbrand-0.1.0/pyproject.toml

@@ -0,0 +1,77 @@
+[project]
+name = "openbrand"
+version = "0.1.0"
+description = "Extract brand assets (logos, colors, backdrops) from any website. A dependency-light Python alternative to the openbrand npm package."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Cass", email = "cassidyhhaas@gmail.com" },
+]
+keywords = [
+    "brand",
+    "logo",
+    "favicon",
+    "color-extraction",
+    "scraping",
+    "web",
+    "metadata",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Multimedia :: Graphics",
+    "Typing :: Typed",
+]
+dependencies = [
+    "Pillow>=10.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/cassidyhhaas/openbrand-py"
+Repository = "https://github.com/cassidyhhaas/openbrand-py"
+Issues = "https://github.com/cassidyhhaas/openbrand-py/issues"
+Changelog = "https://github.com/cassidyhhaas/openbrand-py/releases"
+
+[project.scripts]
+openbrand = "openbrand.cli:main"
+
+[project.optional-dependencies]
+async = [
+    "httpx>=0.27.0",
+]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "httpx>=0.27.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/openbrand"]
+
+[tool.hatch.build.targets.sdist]
+# Ship source for reproducible builds, but skip the 1MB fixture tarball worth
+# of captured HTML snapshots — they're regression-test inputs, not library code.
+include = [
+    "src/openbrand",
+    "tests/test_*.py",
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+asyncio_mode = "auto"

openbrand-0.1.0/src/openbrand/__init__.py

@@ -0,0 +1,114 @@
+"""openbrand — extract brand assets (logos, colors, backdrops) from any website.
+
+A dependency-light Python port of the npm ``openbrand`` package. The only
+*required* third-party dependency is Pillow (image decoding for color
+quantization); everything else is pure standard library.
+
+Sync use::
+
+    from openbrand import extract_brand_assets
+
+    result = extract_brand_assets("https://stripe.com")
+    if result.ok:
+        print(result.data.brand_name)
+
+Async use (drops cleanly into FastAPI handlers)::
+
+    from openbrand import aextract_brand_assets
+
+    result = await aextract_brand_assets("https://stripe.com")
+
+Without extras, ``aextract_brand_assets`` runs the sync pipeline on a worker
+thread (no extra deps, never blocks the event loop). With
+``pip install openbrand[async]`` it switches to a native ``httpx`` backend that
+fetches candidate images concurrently — a measurable speedup on sites with many
+logo candidates.
+"""
+
+from __future__ import annotations
+
+from .backdrops import extract_backdrops
+from .brand_name import extract_brand_name
+from .colors import extract_colors
+from .fetch import FetchError, fetch_html
+from .html_parse import parse
+from .logos import extract_logos
+from .types import (
+    BackdropAsset,
+    BrandAssets,
+    ColorAsset,
+    ExtractionError,
+    ExtractionResult,
+    LogoAsset,
+    Resolution,
+)
+
+__all__ = [
+    "extract_brand_assets",
+    "aextract_brand_assets",
+    "extract_from_html",
+    "BrandAssets",
+    "LogoAsset",
+    "ColorAsset",
+    "BackdropAsset",
+    "Resolution",
+    "ExtractionError",
+    "ExtractionResult",
+]
+
+__version__ = "0.1.0"
+
+
+def extract_from_html(html: str, base_url: str) -> BrandAssets:
+    """Run the extraction pipeline on already-fetched HTML.
+
+    Pure (modulo the network access each extractor performs internally —
+    dimension probes for logos, manifest + image fetches for colors). The
+    sync and async front-doors both funnel through this so the heuristics
+    only live in one place.
+    """
+    doc = parse(html)
+    # Logos first: color quantization samples the discovered logo imagery.
+    logos = extract_logos(doc, base_url)
+    return BrandAssets(
+        brand_name=extract_brand_name(doc, base_url),
+        logos=logos,
+        colors=extract_colors(doc, base_url, logos),
+        backdrops=extract_backdrops(doc, base_url),
+    )
+
+
+def extract_brand_assets(url: str) -> ExtractionResult:
+    """Fetch ``url`` and extract its brand assets.
+
+    Returns an :class:`ExtractionResult`: on success ``result.ok`` is ``True`` and
+    ``result.data`` is a :class:`BrandAssets`; on failure ``result.ok`` is
+    ``False`` and ``result.error`` is a classified :class:`ExtractionError`.
+    Network/HTTP failures are reported via the error path rather than raised.
+    """
+    try:
+        html, final_url = fetch_html(url)
+    except FetchError as exc:
+        return ExtractionResult.failure(exc.error)
+    return ExtractionResult.success(extract_from_html(html, final_url))
+
+
+async def aextract_brand_assets(url: str) -> ExtractionResult:
+    """Async front-door, safe to call from FastAPI handlers / any event loop.
+
+    Picks a backend at call time:
+
+    * ``openbrand[async]`` installed → native ``httpx`` backend that fetches
+      the page and pre-warms candidate-image bytes **concurrently**, then runs
+      the synchronous heuristics with everything already in cache.
+    * ``httpx`` not importable → :func:`asyncio.to_thread` wraps the sync
+      pipeline so the event loop never blocks, at the cost of no in-extraction
+      concurrency. Identical return value either way.
+    """
+    try:
+        import httpx  # noqa: F401
+    except ImportError:
+        import asyncio
+        return await asyncio.to_thread(extract_brand_assets, url)
+    from ._async import aextract_with_httpx
+    return await aextract_with_httpx(url)

openbrand-0.1.0/src/openbrand/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())