Metadata-Version: 2.4
Name: brandaudit
Version: 0.1.0
Summary: A Python library that audits brand consistency for any website
Author: Shaislamova
License: MIT
Project-URL: Homepage, https://github.com/shoislamova/brandaudit
Project-URL: Repository, https://github.com/shoislamova/brandaudit
Keywords: brand,audit,marketing,design,colors,fonts,tone,consistency
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28.0
Requires-Dist: beautifulsoup4>=4.11.0
Requires-Dist: Pillow>=9.0.0
Requires-Dist: colorthief>=0.2.1
Requires-Dist: textblob>=0.17.1
Dynamic: license-file

# 🔍 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

```bash
pip install -r requirements.txt
```

---

## ⚡ Quick Usage

```python
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.
