brickwright 0.1.0__tar.gz

brickwright-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BrickWright Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

brickwright-0.1.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: brickwright
+Version: 0.1.0
+Summary: Agentic LEGO® build generation.
+Keywords: lego,ldraw,agents,llm
+Author: BrickWright Authors
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Dist: bricklayer-sdk
+Requires-Dist: gltflib
+Requires-Dist: ldraw2mesh
+Requires-Dist: litellm
+Requires-Dist: numpy
+Requires-Dist: pillow
+Requires-Dist: pydantic
+Requires-Dist: pygfx
+Requires-Dist: rendercanvas
+Requires-Dist: rich
+Requires-Dist: typer
+Requires-Python: >=3.11
+Project-URL: Homepage, https://avalovelace1.github.io/brickwright/
+Project-URL: Repository, https://github.com/AvaLovelace1/brickwright
+Description-Content-Type: text/markdown
+
+# BrickWright
+
+**BrickWright** is an agentic framework for creating LEGO® builds with
+[BrickLayer](https://github.com/AvaLovelace1/brickwright/tree/main/packages/bricklayer). Using BrickWright,
+you can direct your favorite AI agents (GPT, Claude, Gemini, etc.) to automatically create brick builds from text or
+image prompts and export them to [LDraw](https://www.ldraw.org/).
+
+## Usage
+
+### 1. Install prerequisites
+
+Install the BrickWright CLI. We recommend using [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install brickwright
+```
+
+#### LDraw parts library (optional but recommended)
+
+BrickWright can render a build to a preview image, letting the agent visually check a build. To enable rendering,
+you must download the [LDraw parts library](https://library.ldraw.org/updates?latest) and set the environment
+variable `$LDRAW_LIBRARY_PATH` to its path. Without a library, the rendering tool is disabled.
+
+### 2. Start creating!
+
+#### Option 1: External Agent (e.g. Codex, Claude Code)
+
+Simply prompt your favorite agent to create a brick build following the instructions
+in [EXTERNAL_AGENT_INSTRUCTIONS.md](https://github.com/AvaLovelace1/brickwright/blob/main/packages/brickwright/EXTERNAL_AGENT_INSTRUCTIONS.md).
+
+#### Option 2: API key (e.g. OpenAI Platform, Claude Console)
+
+Ensure that the key for your favorite AI provider is set as an environment
+variable (e.g., `$ANTHROPIC_API_KEY`, `$OPENAI_API_KEY`).
+
+```
+export OPENAI_API_KEY="sk-XXX"
+# OR
+export ANTHROPIC_API_KEY="XXX"
+```
+
+Then, run `brickwright generate`:
+
+```zsh
+brickwright generate "a detailed cruise ship" [--image ref.png] [--model M] [--effort E]
+```
+
+Specify the generation model (e.g. `claude-opus-4-8`, `gpt-5`) with `--model` or by setting the environment variable
+`$BRICKWRIGHT_GENERATION_MODEL`.
+You can run `litellm.get_valid_models()` for a list of available models based on your environment's set API keys.
+
+Results are saved to `--records-dir` (default `./records`, or `$BRICKWRIGHT_RECORDS_DIR`
+if set).
+
+Run `brickwright generate --help` for more options.
+
+---
+
+*LEGO® is a trademark of the LEGO Group, which does not sponsor, authorize, or endorse this project.*

brickwright-0.1.0/README.md

@@ -0,0 +1,59 @@
+# BrickWright
+
+**BrickWright** is an agentic framework for creating LEGO® builds with
+[BrickLayer](https://github.com/AvaLovelace1/brickwright/tree/main/packages/bricklayer). Using BrickWright,
+you can direct your favorite AI agents (GPT, Claude, Gemini, etc.) to automatically create brick builds from text or
+image prompts and export them to [LDraw](https://www.ldraw.org/).
+
+## Usage
+
+### 1. Install prerequisites
+
+Install the BrickWright CLI. We recommend using [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install brickwright
+```
+
+#### LDraw parts library (optional but recommended)
+
+BrickWright can render a build to a preview image, letting the agent visually check a build. To enable rendering,
+you must download the [LDraw parts library](https://library.ldraw.org/updates?latest) and set the environment
+variable `$LDRAW_LIBRARY_PATH` to its path. Without a library, the rendering tool is disabled.
+
+### 2. Start creating!
+
+#### Option 1: External Agent (e.g. Codex, Claude Code)
+
+Simply prompt your favorite agent to create a brick build following the instructions
+in [EXTERNAL_AGENT_INSTRUCTIONS.md](https://github.com/AvaLovelace1/brickwright/blob/main/packages/brickwright/EXTERNAL_AGENT_INSTRUCTIONS.md).
+
+#### Option 2: API key (e.g. OpenAI Platform, Claude Console)
+
+Ensure that the key for your favorite AI provider is set as an environment
+variable (e.g., `$ANTHROPIC_API_KEY`, `$OPENAI_API_KEY`).
+
+```
+export OPENAI_API_KEY="sk-XXX"
+# OR
+export ANTHROPIC_API_KEY="XXX"
+```
+
+Then, run `brickwright generate`:
+
+```zsh
+brickwright generate "a detailed cruise ship" [--image ref.png] [--model M] [--effort E]
+```
+
+Specify the generation model (e.g. `claude-opus-4-8`, `gpt-5`) with `--model` or by setting the environment variable
+`$BRICKWRIGHT_GENERATION_MODEL`.
+You can run `litellm.get_valid_models()` for a list of available models based on your environment's set API keys.
+
+Results are saved to `--records-dir` (default `./records`, or `$BRICKWRIGHT_RECORDS_DIR`
+if set).
+
+Run `brickwright generate --help` for more options.
+
+---
+
+*LEGO® is a trademark of the LEGO Group, which does not sponsor, authorize, or endorse this project.*

brickwright-0.1.0/pyproject.toml

@@ -0,0 +1,91 @@
+[project]
+name = "brickwright"
+version = "0.1.0"
+description = "Agentic LEGO® build generation."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+    "lego",
+    "ldraw",
+    "agents",
+    "llm",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Typing :: Typed",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "bricklayer-sdk",
+    "gltflib",
+    "ldraw2mesh",
+    "litellm",
+    "numpy",
+    "pillow",
+    "pydantic",
+    "pygfx",
+    "rendercanvas",
+    "rich",
+    "typer",
+]
+
+[[project.authors]]
+name = "BrickWright Authors"
+
+[project.urls]
+Homepage = "https://avalovelace1.github.io/brickwright/"
+Repository = "https://github.com/AvaLovelace1/brickwright"
+
+[project.scripts]
+brickwright = "brickwright.cli:main"
+
+[tool.uv.sources.bricklayer-sdk]
+workspace = true
+
+[tool.mutmut]
+source_paths = ["src/"]
+do_not_mutate = ["*/_build_template.py"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests/"]
+addopts = "--import-mode=importlib --strict-markers"
+markers = [
+    "integration: drives the full agent loop (run_agent), the CLI, or a real subprocess",
+    "real_agent: runs a real AI agent with an API key",
+]
+filterwarnings = ["ignore::DeprecationWarning:pygfx"]
+
+[tool.ruff]
+extend-exclude = ["tests/assets"]
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.ruff.lint.per-file-ignores]
+"src/brickwright/tools/*.py" = [
+    "BLE001",
+    "S102",
+]
+"tests/**" = ["S102"]
+
+[tool.ty.environment]
+python = "../../.venv"
+
+[build-system]
+requires = ["uv_build>=0.11.2,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mutmut",
+    "pytest",
+    "pytest-cov",
+    "pytest-regressions",
+    "ruff",
+    "ty",
+]

brickwright-0.1.0/pyproject.toml.orig

@@ -0,0 +1,86 @@
+[project]
+name = "brickwright"
+version = "0.1.0"
+description = "Agentic LEGO® build generation."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "BrickWright Authors" }]
+keywords = ["lego", "ldraw", "agents", "llm"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Typing :: Typed",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "bricklayer-sdk",
+    "gltflib",
+    "ldraw2mesh",
+    "litellm",
+    "numpy",
+    "pillow",
+    "pydantic",
+    "pygfx",
+    "rendercanvas",
+    "rich",
+    "typer",
+]
+
+[tool.uv.sources]
+bricklayer-sdk = { workspace = true }
+
+[project.urls]
+Homepage = "https://avalovelace1.github.io/brickwright/"
+Repository = "https://github.com/AvaLovelace1/brickwright"
+
+[project.scripts]
+brickwright = "brickwright.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.11.2,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mutmut",
+    "pytest",
+    "pytest-cov",
+    "pytest-regressions",
+    "ruff",
+    "ty",
+]
+
+[tool.mutmut]
+source_paths = ["src/"]
+do_not_mutate = ["*/_build_template.py"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests/"]
+addopts = "--import-mode=importlib --strict-markers"
+markers = [
+    "integration: drives the full agent loop (run_agent), the CLI, or a real subprocess",
+    "real_agent: runs a real AI agent with an API key",
+]
+filterwarnings = [
+    "ignore::DeprecationWarning:pygfx",
+]
+
+[tool.ruff]
+# Test assets are captured, generated build.py files (fixtures) -- not project code.
+extend-exclude = ["tests/assets"]
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.ruff.lint.per-file-ignores]
+# tools must never propagate errors, hence general exception catch (BLE001).
+# `exec` is how tools run agent snippets (S102).
+"src/brickwright/tools/*.py" = ["BLE001", "S102"]
+"tests/**" = ["S102"]  # tests exec the generated model template
+
+[tool.ty.environment]
+python = "../../.venv" # point ty to the shared venv

brickwright-0.1.0/src/brickwright/__init__.py

@@ -0,0 +1,5 @@
+"""BrickWright: an agent harness for building LEGO models with BrickLayer."""
+
+from .tools.testing import TestContext
+
+__all__ = ["TestContext"]

brickwright-0.1.0/src/brickwright/__main__.py

@@ -0,0 +1,6 @@
+"""Enable ``python -m brickwright`` as an alias for the CLI."""
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

brickwright-0.1.0/src/brickwright/_build_template.py

@@ -0,0 +1,25 @@
+import bricklayer as bl
+
+from brickwright import TestContext
+
+
+def create_build():
+    """Return the finished :class:`bricklayer.LegoBuild`."""
+    build = bl.LegoBuild()
+    # TODO: assemble the requested build
+    build.add(
+        bl.brick(2, 2, color=bl.Color.RED), bl.Position(0, 0, 0), bl.Rotation.FRONT
+    )
+    return build
+
+
+def run_tests():
+    """Create the build and return a report of which checks passed."""
+    build = create_build()
+    tests = TestContext(build)
+    tests.check_no_floating()
+    tests.check_no_collisions()
+    tests.check_connected(expected_components=1)
+    # Add a custom check for any measurable requirement, e.g.:
+    # tests.check("over 100 bricks", build.brick_count > 100)
+    return tests.report()