No description
- Python 58.2%
- HTML 21.4%
- JavaScript 13.6%
- CSS 6.8%
219d942a3c
Publishable community edition of Brandguard with paid engines and internal integrations removed. Commercial (paid features gated, engines not bundled): - Remove src/brandguard/revenue/ (Pro monetization) entirely - Remove advanced monitoring (autonomy/) and performance (performance/) engines - Stub Pro guideline engines behind a licensing error and drop their implementations: GuidelineValidator.validate_text, ConsistencyChecker.generate_consistency_report, ComplianceReporter.generate_report - Keep free-tier features: brand identity, guideline management, asset library, ValidationResult, and basic color/typography/logo checks Security: - Remove internal Nexus fleet client (nexus_client.py) - Drop pinned private gozerai-telemetry git dependency - Sanitize internal ownership metadata from module docstrings - Point pricing-page links at the public repository Tests adjusted for the community surface; 74 pass, ruff clean. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> |
||
|---|---|---|
| .github/workflows | ||
| docs/pricing | ||
| frontend | ||
| src/brandguard | ||
| tests | ||
| .env.example | ||
| .gitignore | ||
| Dockerfile.api | ||
| LICENSE | ||
| LICENSING.md | ||
| pyproject.toml | ||
| README.md | ||
Brandguard
Brand guidelines, asset management, and consistency enforcement — Part of the GozerAI ecosystem.
Overview
Brandguard provides a programmatic toolkit for defining, organizing, and enforcing brand identity standards: visual identity (colors, typography, logos), voice and tone guidelines, and a brand asset library.
This is the community edition. Advanced content validation, cross-content consistency reporting, compliance reporting, and executive/autonomous analysis are commercial features — their engines are not bundled here and their entry points raise a licensing error pointing to the upgrade path.
Features (Community Tier)
- Brand identity management —
BrandIdentity,ColorPalette,Typography,BrandAsset,BrandGuideline,BrandVoiceGuideline - Guideline management — store, categorize, search, and persist brand
guidelines (
GuidelineManager) - Asset library — organize brand assets and collections (
AssetLibrary,AssetManager) - Basic consistency checks — validate colors and fonts against the brand
palette and typography system (
ConsistencyChecker.check_color_usage,check_typography,check_logo_usage) - Validation result model —
ValidationResultscoring primitives - Service layer —
BrandServiceunified high-level API - License integration — Vinzy license gate for feature tiers
Commercial Tiers
Pro and Growth tiers unlock the advanced engines:
- Advanced content validation (voice, vocabulary, readability, sentiment, repetition, content-type rules)
- Cross-content consistency reporting
- Compliance reporting
- Executive reports and autonomous brand analysis
Set VINZY_LICENSE_KEY with a valid license to enable them, or visit
gozerai.com/pricing for tier details.
Installation
pip install brandguard
For development:
pip install -e ".[dev]"
Quick Start
from brandguard import BrandService
service = BrandService()
# Create a brand identity
service.create_identity(
name="Acme Corp",
tagline="Building the future",
primary_tone="professional",
voice_attributes=["confident", "trustworthy"],
primary_color="#1A73E8",
primary_font="Inter",
)
# Manage guidelines (community tier)
service.add_guideline(
category="voice",
title="Use active voice",
description="Prefer active over passive constructions.",
)
# Register a brand asset (community tier)
service.add_asset(name="Primary Logo", asset_type="logo")
Running Tests
pytest tests/ -v
Requirements
- Python >= 3.10
- Core library uses the standard library only. The optional HTTP API
(
pip install -e ".[api]") adds FastAPI/uvicorn.
License
MIT License. See LICENSE for details.
Links
- Pricing & Licensing: https://gozerai.com/pricing
- Documentation: https://gozerai.com/docs/brandguard