Skip to main content

A Python library that audits brand consistency for any website

Project description

๐Ÿ” BrandAudit

A Python library that audits brand consistency for any website โ€” colors, fonts, tone of voice, and more.


๐Ÿš€ What It Does

Give BrandAudit a URL and it returns a full brand audit:

  • ๐ŸŽจ Colors โ€” extracts brand colors from CSS and images
  • ๐Ÿ”ค Fonts โ€” detects fonts used across the website
  • ๐Ÿ—ฃ๏ธ Tone โ€” analyzes voice and messaging consistency (coming soon)
  • ๐Ÿ“Š Score โ€” gives a brand consistency score out of 100 (coming soon)
  • ๐Ÿ“„ Report โ€” exports a PDF or HTML report (coming soon)

๐Ÿ“ฆ Installation

pip install -r requirements.txt

โšก Quick Usage

import brandaudit

# Audit a website
result = brandaudit.audit("https://nike.com")

# See the colors found
print(result["visual"]["colors"])

# See the fonts found
print(result["visual"]["fonts"])

๐Ÿ“ Project Structure

brandaudit/
โ”‚
โ”œโ”€โ”€ brandaudit/
โ”‚   โ”œโ”€โ”€ __init__.py     # Main entry point
โ”‚   โ”œโ”€โ”€ visual.py       # Module 1: Colors & Fonts
โ”‚   โ”œโ”€โ”€ voice.py        # Module 2: Tone of Voice (coming soon)
โ”‚   โ”œโ”€โ”€ social.py       # Module 3: Social Media (coming soon)
โ”‚   โ””โ”€โ”€ report.py       # Module 4: Scoring & Reports (coming soon)
โ”‚
โ”œโ”€โ”€ tests/
โ”‚   โ””โ”€โ”€ test_visual.py
โ”‚
โ”œโ”€โ”€ requirements.txt
โ””โ”€โ”€ README.md

๐Ÿงฉ Modules

Module Status Description
visual.py โœ… Ready Color & font extraction
voice.py ๐Ÿ”œ Coming soon Tone of voice analysis
social.py ๐Ÿ”œ Coming soon Social media consistency
report.py ๐Ÿ”œ Coming soon Scoring & report export

๐Ÿ›  Tech Stack

  • requests โ€” fetch web pages
  • beautifulsoup4 โ€” parse HTML
  • Pillow โ€” image processing
  • colorthief โ€” dominant color extraction

๐Ÿ‘ฉโ€๐Ÿ’ป Author

Shaislamova โ€” Built with โค๏ธ for marketers and designers.


๐Ÿ“„ License

MIT License โ€” free to use, modify, and share.

Project details


Download files

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

Source Distribution

brandaudit-0.1.0.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

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

brandaudit-0.1.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file brandaudit-0.1.0.tar.gz.

File metadata

  • Download URL: brandaudit-0.1.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc2

File hashes

Hashes for brandaudit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4822cae20109e6ac885f08f3c5feabdeb8f98f7e6f0f34682fca553bba2d10f0
MD5 256ffda6d220ca13f58feb8c85be4552
BLAKE2b-256 62196d46af3512ff18ed9bbe4ba8e2c4516e8d88666f2777b9d4e23be92f4090

See more details on using hashes here.

File details

Details for the file brandaudit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: brandaudit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc2

File hashes

Hashes for brandaudit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03412446075bd8a10b33615d26667e12b5c56158b12950c4dbdf33ddac050f92
MD5 a88d87af59321e94c01bff4109957bab
BLAKE2b-256 0f75204b25fbb0353f44b51c89a2fedc5170065f24ad35886184dcccb95386c1

See more details on using hashes here.

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