brandgen 2.0.0__tar.gz

brandgen-2.0.0/.github/workflows/test.yml

@@ -0,0 +1,73 @@
+# SPDX-FileCopyrightText: 2026 brandgen developers
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  # Formatting, lint and licensing, independent of the Python version.
+  check:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Check formatting
+        run: uv run --only-group dev ruff format --check
+      - name: Lint
+        run: uv run --only-group dev ruff check
+      - name: Check REUSE compliance
+        run: uvx reuse lint
+
+  test:
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      # cairosvg loads the system cairo library at run time.
+      - name: Install cairo
+        run: sudo apt-get update && sudo apt-get install --yes libcairo2
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Run the test suite
+        run: uv run pytest
+      - name: Build the distributions
+        run: uv build
+      # Install the wheel on its own, away from the checkout, and run a
+      # complete build of a synthetic brand through the console script.
+      - name: Run the installed command line end to end
+        run: |
+          uv venv "$RUNNER_TEMP/wheel"
+          uv pip install --python "$RUNNER_TEMP/wheel" dist/*.whl
+          export PATH="$RUNNER_TEMP/wheel/bin:$PATH"
+          brandgen --version
+          python tests/sample.py "$RUNNER_TEMP/source"
+          brandgen build --input "$RUNNER_TEMP/source" \
+            --output "$RUNNER_TEMP/generated" --name ci --quiet
+          planned=$(brandgen plan --name ci 2>/dev/null | sort)
+          written=$(cd "$RUNNER_TEMP/generated" \
+            && find . -type f ! -name manifest.json | sed 's|^\./||' | sort)
+          listed=$(python -c 'import json, sys; print("\n".join(sorted(
+            f["path"] for f in json.load(open(sys.argv[1]))["files"])))' \
+            "$RUNNER_TEMP/generated/manifest.json")
+          test "$planned" = "$written"
+          test "$planned" = "$listed"
+          echo "$(echo "$planned" | wc -l) files planned, written and listed"
+      - name: Keep the generated variants
+        if: matrix.python == '3.13'
+        uses: actions/upload-artifact@v4
+        with:
+          name: generated-sample
+          path: ${{ runner.temp }}/generated

brandgen-2.0.0/.gitignore

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2026 brandgen developers
+#
+# SPDX-License-Identifier: Apache-2.0
+
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+.venv/
+dist/
+uv.lock

brandgen-2.0.0/LICENSES/Apache-2.0.txt

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

brandgen-2.0.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.5
+Name: brandgen
+Version: 2.0.0
+Summary: Generate every distribution variant of a brand's marks
+License-Expression: Apache-2.0
+License-File: LICENSES/Apache-2.0.txt
+Requires-Python: >=3.11
+Requires-Dist: cairosvg>=2.7
+Requires-Dist: fonttools>=4.47
+Requires-Dist: lxml>=5
+Requires-Dist: svgelements>=1.9
+Requires-Dist: uharfbuzz>=0.39
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2026 brandgen developers
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# brandgen
+
+Generates every distribution variant of a brand's marks from a source
+directory. The brand assets live with the brand; this package only holds the
+code.
+
+```
+uv run brandgen build --input path/to/source --output path/to/generated \
+    --name kprof
+```
+
+## Input
+
+The `--input` directory must contain:
+
+| File | Purpose |
+|------|---------|
+| `icon.svg` | The icon. |
+| `wordmark.svg` | The wordmark, outlined or as live text. |
+| exactly one `*.ttf` | The brand font. |
+
+Anything else in the directory, such as a hand-made `logo.svg` or a palette,
+is ignored. The logo is composed from the icon and the wordmark.
+
+The font is used for two things. Live `<text>` in either SVG is converted to
+outlines with it, so no renderer needs the font installed. And it locates the
+wordmark's baseline: the wordmark text, read from its `aria-label` (Inkscape
+writes one when converting text to paths), is set in the font and matched to
+the outlines. Without a label the bottom of the ink is used and the build
+says so.
+
+## The logo
+
+The logo is the mark `logo-horizontal`: the icon on the left and the
+wordmark to its right. All lengths are fractions of the icon's ink height:
+
+| Option | Default | Meaning |
+|--------|---------|---------|
+| `--body` | `0.625` | Height of the wordmark from the top of its ink to the baseline. |
+| `--gap` | `0.2205625` | Space between the icon's ink and the wordmark's ink. |
+
+The wordmark body is centred vertically on the icon, and descenders hang
+below it as in running text. Ink that reaches only slightly below the
+baseline, the overshoot of round letters, counts as part of the body.
+
+The defaults reproduce the Ambhora logo. The kprof logo uses
+`--gap 0.359375`.
+
+Only the horizontal arrangement exists. A vertical one is a new
+`brandgen.lockup.Arrangement` member and one placement branch in
+`brandgen.lockup.compose`; its mark would be `logo-vertical`.
+
+## Output
+
+Every mark in every legible colourway, background, padding and format:
+
+| | transparent | white | black |
+|-|:-:|:-:|:-:|
+| **color** | yes | yes | yes |
+| **white** | yes | | yes |
+| **black** | yes | yes | |
+
+| Padding | Clear space | Marks |
+|---------|-------------|-------|
+| `none` | the source page; for the logo, the composed page | all |
+| `tight` | 10% of ink height | all |
+| `clearspace` | 25% of ink height | all |
+| `generous` | 50% of ink height | all |
+| `avatar` | 10% of ink height, on a square | icon |
+
+Formats are SVG, PDF (200 mm wide unless `--pdf-width-mm` says otherwise)
+and PNG at 256, 512 and 1024 pixels (`--png-width`, repeatable). Padding
+widens the canvas around the ink; the artwork itself is never moved.
+
+Files are laid out as
+
+```
+<output>/<mark>/<format>/<name>-<mark>-<colorway>-on-<background>-<padding>[-<width>px].<ext>
+```
+
+and `<output>/manifest.json` lists every file with its size, SHA-256 and
+canvas, together with the checksums of the three source files and the
+layout used. SVG and PNG output is byte-for-byte reproducible; PDFs differ
+between runs only in the creation date cairo writes into them.
+
+Derived SVGs keep the comments in front of the source's root element, such
+as an SPDX header, and drop editor metadata and `<metadata>` blocks.
+
+`--mark`, `--colorway`, `--background`, `--padding` and `--format` narrow the
+matrix; each is repeatable. `brandgen plan --name <name>` lists the files a
+build would write, and `brandgen paddings` explains the padding rules.
+
+## Development
+
+```
+uv sync
+uv run pytest
+uv run ruff check
+uv run ruff format --check
+```
+
+The tests build their own font and marks, so the repository holds no brand
+assets.
+
+## Layout
+
+```
+src/brandgen/
+  source.py     locating icon, wordmark and font
+  document.py   reading, recolouring, recanvassing and writing SVG
+  typeset.py    shaping with the brand font, outlining live text
+  measure.py    ink boxes and the wordmark baseline
+  lockup.py     composing the logo
+  variant.py    the variant matrix and file naming
+  render.py     PNG and PDF through cairosvg
+  build.py      running a build and writing the manifest
+  cli.py        command line interface
+  metadata.py   version
+```

brandgen-2.0.0/pyproject.toml

@@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: 2026 brandgen developers
+#
+# SPDX-License-Identifier: Apache-2.0
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "brandgen"
+dynamic = ["version"]
+description = "Generate every distribution variant of a brand's marks"
+readme = "readme.md"
+license = "Apache-2.0"
+license-files = ["LICENSES/*"]
+requires-python = ">=3.11"
+dependencies = [
+  "cairosvg>=2.7",
+  "fonttools>=4.47",
+  "lxml>=5",
+  "svgelements>=1.9",
+  "uharfbuzz>=0.39",
+]
+
+[project.scripts]
+brandgen = "brandgen.cli:main"
+
+[dependency-groups]
+dev = [
+  "pillow>=10",
+  "pytest>=8",
+  "ruff>=0.6",
+]
+
+[tool.hatch.version]
+path = "src/brandgen/metadata.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/brandgen"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 80
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "TID"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.lint.isort]
+# The synthetic brand used by the tests, imported from the tests directory.
+known-local-folder = ["sample"]

brandgen-2.0.0/readme.md

@@ -0,0 +1,125 @@
+<!--
+SPDX-FileCopyrightText: 2026 brandgen developers
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# brandgen
+
+Generates every distribution variant of a brand's marks from a source
+directory. The brand assets live with the brand; this package only holds the
+code.
+
+```
+uv run brandgen build --input path/to/source --output path/to/generated \
+    --name kprof
+```
+
+## Input
+
+The `--input` directory must contain:
+
+| File | Purpose |
+|------|---------|
+| `icon.svg` | The icon. |
+| `wordmark.svg` | The wordmark, outlined or as live text. |
+| exactly one `*.ttf` | The brand font. |
+
+Anything else in the directory, such as a hand-made `logo.svg` or a palette,
+is ignored. The logo is composed from the icon and the wordmark.
+
+The font is used for two things. Live `<text>` in either SVG is converted to
+outlines with it, so no renderer needs the font installed. And it locates the
+wordmark's baseline: the wordmark text, read from its `aria-label` (Inkscape
+writes one when converting text to paths), is set in the font and matched to
+the outlines. Without a label the bottom of the ink is used and the build
+says so.
+
+## The logo
+
+The logo is the mark `logo-horizontal`: the icon on the left and the
+wordmark to its right. All lengths are fractions of the icon's ink height:
+
+| Option | Default | Meaning |
+|--------|---------|---------|
+| `--body` | `0.625` | Height of the wordmark from the top of its ink to the baseline. |
+| `--gap` | `0.2205625` | Space between the icon's ink and the wordmark's ink. |
+
+The wordmark body is centred vertically on the icon, and descenders hang
+below it as in running text. Ink that reaches only slightly below the
+baseline, the overshoot of round letters, counts as part of the body.
+
+The defaults reproduce the Ambhora logo. The kprof logo uses
+`--gap 0.359375`.
+
+Only the horizontal arrangement exists. A vertical one is a new
+`brandgen.lockup.Arrangement` member and one placement branch in
+`brandgen.lockup.compose`; its mark would be `logo-vertical`.
+
+## Output
+
+Every mark in every legible colourway, background, padding and format:
+
+| | transparent | white | black |
+|-|:-:|:-:|:-:|
+| **color** | yes | yes | yes |
+| **white** | yes | | yes |
+| **black** | yes | yes | |
+
+| Padding | Clear space | Marks |
+|---------|-------------|-------|
+| `none` | the source page; for the logo, the composed page | all |
+| `tight` | 10% of ink height | all |
+| `clearspace` | 25% of ink height | all |
+| `generous` | 50% of ink height | all |
+| `avatar` | 10% of ink height, on a square | icon |
+
+Formats are SVG, PDF (200 mm wide unless `--pdf-width-mm` says otherwise)
+and PNG at 256, 512 and 1024 pixels (`--png-width`, repeatable). Padding
+widens the canvas around the ink; the artwork itself is never moved.
+
+Files are laid out as
+
+```
+<output>/<mark>/<format>/<name>-<mark>-<colorway>-on-<background>-<padding>[-<width>px].<ext>
+```
+
+and `<output>/manifest.json` lists every file with its size, SHA-256 and
+canvas, together with the checksums of the three source files and the
+layout used. SVG and PNG output is byte-for-byte reproducible; PDFs differ
+between runs only in the creation date cairo writes into them.
+
+Derived SVGs keep the comments in front of the source's root element, such
+as an SPDX header, and drop editor metadata and `<metadata>` blocks.
+
+`--mark`, `--colorway`, `--background`, `--padding` and `--format` narrow the
+matrix; each is repeatable. `brandgen plan --name <name>` lists the files a
+build would write, and `brandgen paddings` explains the padding rules.
+
+## Development
+
+```
+uv sync
+uv run pytest
+uv run ruff check
+uv run ruff format --check
+```
+
+The tests build their own font and marks, so the repository holds no brand
+assets.
+
+## Layout
+
+```
+src/brandgen/
+  source.py     locating icon, wordmark and font
+  document.py   reading, recolouring, recanvassing and writing SVG
+  typeset.py    shaping with the brand font, outlining live text
+  measure.py    ink boxes and the wordmark baseline
+  lockup.py     composing the logo
+  variant.py    the variant matrix and file naming
+  render.py     PNG and PDF through cairosvg
+  build.py      running a build and writing the manifest
+  cli.py        command line interface
+  metadata.py   version
+```

brandgen-2.0.0/src/brandgen/__init__.py

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2026 brandgen developers
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Generate every distribution variant of a brand's marks.
+
+The input is a source directory with ``icon.svg``, ``wordmark.svg`` and the
+brand font as a ``.ttf``.  The logo is composed from the icon and the
+wordmark, and every mark is written in every legible colourway, background,
+padding and format.  See ``brandgen.build`` for the entry point.
+"""

brandgen-2.0.0/src/brandgen/__main__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2026 brandgen developers
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Entry point for ``python -m brandgen``."""
+
+import brandgen.cli as _cli
+
+raise SystemExit(_cli.main())