napkin2factory 0.1.0__tar.gz

napkin2factory-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+.env
+.venv/
+__pycache__/
+*.pyc
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+examples/*/build/
+.DS_Store

napkin2factory-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 osama
+
+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.

napkin2factory-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.5
+Name: napkin2factory
+Version: 0.1.0
+Summary: From napkin to factory: a text-only product model compiled into a manufacturable technical data package, with an engineering-change loop that rebuilds exactly what changed.
+Project-URL: Homepage, https://github.com/osaxma/napkin2factory
+Author: osama
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bom,build123d,cad,eco,engineering-change,manufacturing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Manufacturing
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: <3.15,>=3.13
+Requires-Dist: build123d<0.13,>=0.12
+Requires-Dist: ezdxf>=1.3
+Requires-Dist: httpx>=0.27
+Requires-Dist: jinja2>=3.1
+Requires-Dist: markdown-it-py>=3.0
+Requires-Dist: numpy>=2.0
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: packaging>=24.0
+Requires-Dist: pint>=0.24
+Requires-Dist: pydantic>=2.9
+Requires-Dist: pygltflib>=1.16
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: ruamel-yaml>=0.18
+Requires-Dist: typer>=0.15
+Requires-Dist: typst>=0.13
+Description-Content-Type: text/markdown
+
+# napkin2factory
+
+**From napkin to factory.** Describe a physical product as text; get a manufacturable
+technical data package — 3D models, drawings, flat patterns, bill of materials, manuals and
+a self-contained report — and change it safely: every engineering change rebuilds exactly
+what it invalidates, shows its impact before anything moves, and ships as a diff page.
+
+> **Disclaimer.** napkin2factory designs are produced with an AI system and have not been
+> reviewed by a licensed engineer. Every report, manual, drawing and package it generates
+> says so. Have a qualified person review a design before you build, power or use it.
+> Safety requirements can never pass by computation alone; they need a human sign-off.
+
+Version 0.1 covers mechanical parts and the bill of materials. Electrical design, FEA and
+hosted services are not included (see `BACKLOG.md`).
+
+## Install (from source)
+
+Requires [uv](https://docs.astral.sh/uv/) (`curl -LsSf https://astral.sh/uv/install.sh | sh`);
+`uv sync` fetches Python 3.13 itself if the machine has none. The repository is private
+until launch, so the clone line is for people with access; everyone else unpacks the source
+archive they were given and starts at `cd`.
+
+```bash
+git clone https://github.com/osaxma/napkin2factory.git   # or unpack the source archive
+cd napkin2factory
+uv sync                 # add --no-dev if you only want to run it, not develop it
+uv run n2f version      # napkin2factory 0.1.0
+uv run n2f doctor       # is this machine ready?
+```
+
+`uv run n2f …` only works from inside this checkout. To have `n2f` on your PATH and usable
+from any folder:
+
+```bash
+uv tool install .
+```
+
+or `pip install -e .` into a virtual environment. Once the package is published,
+`uvx napkin2factory` will work without a checkout.
+
+## Ten-minute first run
+
+```bash
+uv run n2f init demo --template bracket
+cd demo
+uv run n2f build        # the first build loads the CAD kernel: about two minutes, then seconds
+uv run n2f check
+open build/report/index.html        # macOS; Linux: xdg-open …; or: uv run n2f serve
+```
+
+The first `n2f build` on a machine prints "loading the CAD kernel…" and then sits silent for
+a minute or two while the kernel loads; later builds take seconds. Builds also check that
+each bought part's vendor link still resolves; set `N2F_OFFLINE=1` (or pass `--offline`) to
+skip that.
+
+The report opens straight from disk: a 3D view you can orbit, drawings, the bill of
+materials with a "what to tell the manufacturer" column, and the check matrix. Try a change:
+
+```bash
+uv run n2f ecr new --title "Longer bracket" --set param://bracket-length=140mm
+uv run n2f ecr impact ECR-001          # what it touches, before anything changes
+uv run n2f ecr approve ECR-001 --by "me"
+uv run n2f ecr apply ECR-001
+uv run n2f build && uv run n2f check
+uv run n2f ecr close ECR-001
+uv run n2f release v1.0.0
+```
+
+Make a second change the same way, release it as `v1.1.0`, and the headline diff page is
+one command away:
+
+```bash
+uv run n2f diff v1.0.0 v1.1.0          # → build/site/diff/v1.0.0..v1.1.0/index.html
+```
+
+`n2f status` always tells you where the product stands and what to do next.
+
+**Sign-offs.** Some requirements cannot be checked by computation (the enclosure template
+has one: inspect every edge by hand). `n2f check` lists them as `needs your sign-off` and
+still exits 0, but `n2f release` refuses until a person has recorded the review:
+
+```bash
+uv run n2f signoff REQ-004 --by "your name" --statement "what you inspected"
+```
+
+`n2f status` prints the exact command to run. A sign-off stays valid until the evidence it
+was bound to changes.
+
+## The three doors
+
+1. **Chat app only** — planned: a connector or skill that lets a chat assistant run the
+   intake and build in its own sandbox.
+2. **GitHub template** — planned: "Use this template", GitHub Actions as the build machine,
+   Pages as the product site. Every product folder already carries the workflow files.
+3. **Local CLI** — this: `uv run n2f …` (or `n2f …` after `uv tool install .`), works
+   offline (`N2F_OFFLINE=1`), no accounts. Open the product folder in Claude Code, Codex or
+   any coding agent: the folder's `CLAUDE.md` and skills turn it into the project team.
+
+## The showcase: a 1200 °C test kiln
+
+`examples/kiln` is a complete product: 21 parts, interfaces, thermal and element calcs,
+six manuals, example sign-offs, and two change requests. `examples/kiln/demo.sh` runs the
+parametric engineering-change loop unattended (release → change → impact → approve → apply →
+rebuild → check → re-sign → release → diff page); `demo-design.sh` adds a design change
+applied from a pre-authored patch.
+
+## Learn more
+
+- `docs/concepts.md` — the ideas (one canonical model, recorded dependencies, checks as the gate)
+- `docs/cli.md` — every command · `docs/vocabulary.md` — the glossary (draft, snapshot,
+  change request, Revision … and what each means underneath)
+- `docs/product-model.md` — the files in a product folder · `docs/kit.md` — the part generators
+- `docs/checks.md` — how verification works · `docs/ecr-loop.md` — the change loop
+- `docs/agent-layer.md` — the roles a product folder installs for AI clients
+
+## Developing
+
+```bash
+make check        # lint, types, tests, both small examples (6–10 min; sets N2F_OFFLINE=1)
+make check-full   # + the kiln, both demos, timing assertions (N2F_TIMING=1)
+```
+
+See `CLAUDE.md` for the rules, `GRAND_PLAN.md` for the plan this version was built to, and
+`DECISIONS.md` / `STATUS.md` / `BACKLOG.md` for the build journal.
+
+## License
+
+MIT — see `LICENSE`.

napkin2factory-0.1.0/README.md

@@ -0,0 +1,128 @@
+# napkin2factory
+
+**From napkin to factory.** Describe a physical product as text; get a manufacturable
+technical data package — 3D models, drawings, flat patterns, bill of materials, manuals and
+a self-contained report — and change it safely: every engineering change rebuilds exactly
+what it invalidates, shows its impact before anything moves, and ships as a diff page.
+
+> **Disclaimer.** napkin2factory designs are produced with an AI system and have not been
+> reviewed by a licensed engineer. Every report, manual, drawing and package it generates
+> says so. Have a qualified person review a design before you build, power or use it.
+> Safety requirements can never pass by computation alone; they need a human sign-off.
+
+Version 0.1 covers mechanical parts and the bill of materials. Electrical design, FEA and
+hosted services are not included (see `BACKLOG.md`).
+
+## Install (from source)
+
+Requires [uv](https://docs.astral.sh/uv/) (`curl -LsSf https://astral.sh/uv/install.sh | sh`);
+`uv sync` fetches Python 3.13 itself if the machine has none. The repository is private
+until launch, so the clone line is for people with access; everyone else unpacks the source
+archive they were given and starts at `cd`.
+
+```bash
+git clone https://github.com/osaxma/napkin2factory.git   # or unpack the source archive
+cd napkin2factory
+uv sync                 # add --no-dev if you only want to run it, not develop it
+uv run n2f version      # napkin2factory 0.1.0
+uv run n2f doctor       # is this machine ready?
+```
+
+`uv run n2f …` only works from inside this checkout. To have `n2f` on your PATH and usable
+from any folder:
+
+```bash
+uv tool install .
+```
+
+or `pip install -e .` into a virtual environment. Once the package is published,
+`uvx napkin2factory` will work without a checkout.
+
+## Ten-minute first run
+
+```bash
+uv run n2f init demo --template bracket
+cd demo
+uv run n2f build        # the first build loads the CAD kernel: about two minutes, then seconds
+uv run n2f check
+open build/report/index.html        # macOS; Linux: xdg-open …; or: uv run n2f serve
+```
+
+The first `n2f build` on a machine prints "loading the CAD kernel…" and then sits silent for
+a minute or two while the kernel loads; later builds take seconds. Builds also check that
+each bought part's vendor link still resolves; set `N2F_OFFLINE=1` (or pass `--offline`) to
+skip that.
+
+The report opens straight from disk: a 3D view you can orbit, drawings, the bill of
+materials with a "what to tell the manufacturer" column, and the check matrix. Try a change:
+
+```bash
+uv run n2f ecr new --title "Longer bracket" --set param://bracket-length=140mm
+uv run n2f ecr impact ECR-001          # what it touches, before anything changes
+uv run n2f ecr approve ECR-001 --by "me"
+uv run n2f ecr apply ECR-001
+uv run n2f build && uv run n2f check
+uv run n2f ecr close ECR-001
+uv run n2f release v1.0.0
+```
+
+Make a second change the same way, release it as `v1.1.0`, and the headline diff page is
+one command away:
+
+```bash
+uv run n2f diff v1.0.0 v1.1.0          # → build/site/diff/v1.0.0..v1.1.0/index.html
+```
+
+`n2f status` always tells you where the product stands and what to do next.
+
+**Sign-offs.** Some requirements cannot be checked by computation (the enclosure template
+has one: inspect every edge by hand). `n2f check` lists them as `needs your sign-off` and
+still exits 0, but `n2f release` refuses until a person has recorded the review:
+
+```bash
+uv run n2f signoff REQ-004 --by "your name" --statement "what you inspected"
+```
+
+`n2f status` prints the exact command to run. A sign-off stays valid until the evidence it
+was bound to changes.
+
+## The three doors
+
+1. **Chat app only** — planned: a connector or skill that lets a chat assistant run the
+   intake and build in its own sandbox.
+2. **GitHub template** — planned: "Use this template", GitHub Actions as the build machine,
+   Pages as the product site. Every product folder already carries the workflow files.
+3. **Local CLI** — this: `uv run n2f …` (or `n2f …` after `uv tool install .`), works
+   offline (`N2F_OFFLINE=1`), no accounts. Open the product folder in Claude Code, Codex or
+   any coding agent: the folder's `CLAUDE.md` and skills turn it into the project team.
+
+## The showcase: a 1200 °C test kiln
+
+`examples/kiln` is a complete product: 21 parts, interfaces, thermal and element calcs,
+six manuals, example sign-offs, and two change requests. `examples/kiln/demo.sh` runs the
+parametric engineering-change loop unattended (release → change → impact → approve → apply →
+rebuild → check → re-sign → release → diff page); `demo-design.sh` adds a design change
+applied from a pre-authored patch.
+
+## Learn more
+
+- `docs/concepts.md` — the ideas (one canonical model, recorded dependencies, checks as the gate)
+- `docs/cli.md` — every command · `docs/vocabulary.md` — the glossary (draft, snapshot,
+  change request, Revision … and what each means underneath)
+- `docs/product-model.md` — the files in a product folder · `docs/kit.md` — the part generators
+- `docs/checks.md` — how verification works · `docs/ecr-loop.md` — the change loop
+- `docs/agent-layer.md` — the roles a product folder installs for AI clients
+
+## Developing
+
+```bash
+make check        # lint, types, tests, both small examples (6–10 min; sets N2F_OFFLINE=1)
+make check-full   # + the kiln, both demos, timing assertions (N2F_TIMING=1)
+```
+
+See `CLAUDE.md` for the rules, `GRAND_PLAN.md` for the plan this version was built to, and
+`DECISIONS.md` / `STATUS.md` / `BACKLOG.md` for the build journal.
+
+## License
+
+MIT — see `LICENSE`.

napkin2factory-0.1.0/packaging/n2f/README.md

@@ -0,0 +1,4 @@
+# n2f
+
+This package only installs [napkin2factory](https://pypi.org/project/napkin2factory/),
+which provides the `n2f` command. Install either name; you get the same tool.

napkin2factory-0.1.0/packaging/n2f/pyproject.toml

@@ -0,0 +1,21 @@
+# Placeholder that reserves the `n2f` name on PyPI and installs napkin2factory.
+# Its version must match the main package; .github/workflows/publish.yml checks this.
+[project]
+name = "n2f"
+version = "0.1.0"
+description = "Alias for napkin2factory: `pip install n2f` installs napkin2factory and its `n2f` command."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.13,<3.15"
+authors = [{ name = "osama" }]
+dependencies = ["napkin2factory==0.1.0"]
+
+[project.urls]
+Homepage = "https://pypi.org/project/napkin2factory/"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+bypass-selection = true

napkin2factory-0.1.0/pyproject.toml

@@ -0,0 +1,107 @@
+[project]
+name = "napkin2factory"
+version = "0.1.0"
+description = "From napkin to factory: a text-only product model compiled into a manufacturable technical data package, with an engineering-change loop that rebuilds exactly what changed."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.13,<3.15"
+authors = [{ name = "osama" }]
+keywords = ["cad", "build123d", "manufacturing", "bom", "engineering-change", "eco"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Manufacturing",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+]
+dependencies = [
+  "build123d>=0.12,<0.13",
+  "pint>=0.24",
+  "pydantic>=2.9",
+  "pyyaml>=6.0",
+  "ruamel.yaml>=0.18",
+  "typer>=0.15",
+  "jinja2>=3.1",
+  "ezdxf>=1.3",
+  "openpyxl>=3.1",
+  "typst>=0.13",
+  "numpy>=2.0",
+  "httpx>=0.27",
+  "pygltflib>=1.16",
+  "markdown-it-py>=3.0",
+  "rich>=13.0",
+  "packaging>=24.0",
+]
+
+[project.scripts]
+n2f = "napkin2factory.cli.app:main"
+
+[project.urls]
+Homepage = "https://github.com/osaxma/napkin2factory"
+
+[dependency-groups]
+dev = [
+  "pytest>=8.3",
+  "pytest-cov>=6.0",
+  "ruff>=0.8",
+  "mypy>=1.13",
+  "hypothesis>=6.115",
+  "lxml>=5.3",
+  "selectolax>=0.3",
+  "actionlint-py>=1.7",
+  "twine>=6.0",
+  "types-PyYAML",
+  "types-openpyxl",
+  "playwright>=1.48",
+  "pillow>=11.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/napkin2factory"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/napkin2factory", "README.md", "LICENSE", "pyproject.toml"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py313"
+src = ["src", "tests"]
+extend-exclude = ["src/napkin2factory/report/vendor", "src/napkin2factory/templates", "examples", "docs/history"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "D", "E722"]
+ignore = ["D203", "D213", "D105", "D107"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D", "E741"]
+"src/napkin2factory/geometry/**" = ["E741"]   # `I` is the interface accessor by contract (D5)
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.mypy]
+python_version = "3.13"
+strict = true
+warn_unreachable = true
+
+[[tool.mypy.overrides]]
+module = ["OCP", "OCP.*", "build123d", "build123d.*", "ezdxf", "ezdxf.*", "pygltflib", "pygltflib.*", "typst", "pint", "pint.*", "markdown_it", "markdown_it.*", "ruamel", "ruamel.*", "selectolax", "selectolax.*", "lxml", "lxml.*", "hypothesis", "hypothesis.*"]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q -p no:cacheprovider"
+markers = [
+  "timing: timing assertions (only under N2F_TIMING=1)",
+  "full: kiln and demo end-to-end tests, run by make check-full (D27)",
+]
+filterwarnings = ["ignore::DeprecationWarning"]
+
+[tool.coverage.run]
+source = ["napkin2factory.core"]
+branch = false

napkin2factory-0.1.0/src/napkin2factory/__init__.py

@@ -0,0 +1,3 @@
+"""napkin2factory: compile a text-only product model into a manufacturable package."""
+
+__version__ = "0.1.0"

napkin2factory-0.1.0/src/napkin2factory/bom/__init__.py

@@ -0,0 +1 @@
+"""Bill of materials: rollups, validation tiers, CSV/XLSX, curated catalog."""