brand-yml

What it is and what it does

brand.yml is a Python package that reads and structures brand guidelines stored in a portable YAML format. It parses metadata, color palettes, typography rules, and other branding elements into typed Python objects, making them accessible programmatically. The package is designed to work alongside Quarto and Shiny for Python to apply consistent branding across reports, dashboards, and web applications.

You define your company's brand once in a `_brand.yml` file—colors, fonts, logos, and other guidelines—and then load it into Python using the `Brand` class. The structured data can then be consumed by downstream tools to automatically theme outputs. It's part of Posit's effort to unify branding across their open-source ecosystem.

Use it for:

• Load a company brand file and extract color palettes to apply to plots or dashboards.
• Provide brand metadata (name, logo, link) to Shiny applications for consistent header/footer branding.
• Validate brand YAML files against a schema before using them in production rendering pipelines.
• Share a single `_brand.yml` across Python, R, and Quarto projects for unified visual identity.
• Programmatically access typography rules to style text in generated reports or web outputs.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Parses and manages brand guidelines from a YAML file, providing structured access to logos, colors, fonts, and typography for use in Quarto, Shiny, and other tools.

Yes. The package is actively maintained, has no security vulnerabilities, and solves a real problem for teams using Posit tools. Install friction is low, and it integrates cleanly with Quarto and Shiny. Useful if you manage branded outputs across multiple projects or tools; less critical if you only need ad-hoc theming.

Install

brand-yml on PyPI

pip install brand-yml

uv add brand-yml

poetry add brand-yml

Installing brand-yml

Before you install

Low friction install with four runtime dependencies. Active maintenance: last commit 2026-08-11, released 2026-05-21. Supports current Python versions (3.10–3.13). No known vulnerabilities.

License in practice

MIT license (permissive). No restrictions on use, modification, or distribution in commercial or private projects.

Quickstart

pip install brand_yml

from brand_yml import Brand

brand = Brand.from_yaml_str("""
meta:
  name: My Company
color:
  palette:
    primary: "#447099"
  primary: primary
""")

print(brand.meta.name)

Requires Python 3.10 or later.

Verify before relying

• Whether brand.yml integrates directly with Shiny for Python or requires additional setup.
• Whether the package can serialize modified brand objects back to YAML.
• Performance characteristics when parsing large or complex brand files.

Package facts

Evidence: brand_yml-0.2.0-py3-none-any.whl

Tags

More Application Frameworks packages