model-generator-kit 0.1.0__tar.gz

model_generator_kit-0.1.0/LICENSE

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

model_generator_kit-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: model-generator-kit
+Version: 0.1.0
+Summary: One-shot bootstrap generator for database models, API models, routes, and tests
+Author-email: nuncaeslupus <imarcos@gmail.com>
+License: MIT
+Keywords: generator,code-generator,fastapi,sqlalchemy,pydantic,boilerplate
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: jsonschema>=4.0.0
+Provides-Extra: interactive
+Requires-Dist: questionary>=2.0.0; extra == "interactive"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: questionary>=2.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.0; extra == "dev"
+Requires-Dist: types-jsonschema>=4.0.0; extra == "dev"
+Requires-Dist: mutmut>=2.4.0; extra == "dev"
+Requires-Dist: sqlalchemy>=2.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+# Model Generator
+
+A **one-shot bootstrap code generator** that turns JSON specifications into production-ready API backends — database models, API endpoints, tests, and migrations. The generator is stack-agnostic by design; it currently ships the **`python-fastapi`** stack (chosen with `--stack`, the default).
+
+## What It Does
+
+- **Database models** — SQLAlchemy ORM with constraints, relationships, and indexes
+- **API models** — Pydantic request/response schemas with validators
+- **API routes** — FastAPI CRUD endpoints
+- **Tests** — pytest contract tests with FactoryBoy factories (a full contract suite in the example project)
+- **Migrations** — Alembic infrastructure
+
+## Install
+
+`model-generator` is a build-time scaffolding tool, not a runtime dependency of
+the backends it generates. Install it as an isolated global CLI:
+
+```bash
+uv tool install model-generator-kit     # or: pipx install model-generator-kit
+```
+
+This puts `model-gen` and `model-val` on your PATH. For the interactive wizard,
+add the extra: `uv tool install "model-generator-kit[interactive]"`.
+
+> The PyPI package is `model-generator-kit` (the name `model-generator` was already
+> taken); the commands it installs are `model-gen` and `model-val`.
+
+## Quick Start
+
+```bash
+# In any project directory, scaffold from your JSON specs
+model-gen models/ --target all
+
+model-gen --version    # confirm the install
+```
+
+To try the bundled example from a clone of this repo:
+
+```bash
+git clone https://github.com/nuncaeslupus/model-generator && cd model-generator
+uv sync --extra dev
+cd examples/user-auth-project
+uv run model-gen models/ --target all
+uv venv && uv sync --extra dev
+uv run pytest  # the generated contract suite passes
+```
+
+For your own project, see the [Installation Guide](./docs/user/installation.md).
+
+## Documentation
+
+### For Users
+
+- **[Installation Guide](./docs/user/installation.md)** — Install, configure, first project
+- **[Model Design Guide](./docs/user/model-design-guide.md)** — How to design comprehensive JSON specifications
+- **[Usage Guide](./docs/user/usage-guide.md)** — CLI workflows, generation, cleanup, interactive mode
+- **[Quick Reference](./docs/user/quick-reference.md)** — Lookup tables: field types, constraints, options
+- **[Extending Generated Code](./docs/user/extending-generated-code.md)** — Business logic, custom routes, migrations
+
+### For Agents
+
+- **[Model Design Questions](./docs/agent/model-design-questions.md)** — Systematic Q&A for eliciting model specs from users
+- **[Template Extension Guide](./docs/agent/template-extension-guide.md)** — Add types, templates, generators
+- **[JSON Specification Reference](./docs/agent/json-specification-reference.md)** — Exact format, every key, every option
+
+### Deep Dives
+
+- **[Constraints](./docs/deep-dives/constraints.md)** — DB vs API constraint placement, cross-field constraints
+- **[Completeness Guide](./docs/deep-dives/completeness-guide.md)** — JSON specification checklist
+- **[Custom Tests](./docs/deep-dives/custom-tests.md)** — Extending the generated test suite
+
+### For Contributors
+
+- **[Skill Reusability](./docs/contributor/skill-reusability.md)** — Core principles for reusable generation
+- **[Project-Agnostic Rules](./docs/contributor/project-agnostic-rules.md)** — Coding rules for templates and scripts
+
+## Development
+
+```bash
+# Install in editable mode with dev dependencies
+uv sync --extra dev
+
+# Run the test suite
+uv run pytest tests/ -v
+```
+
+### Test Suite
+
+| File | What It Covers |
+|------|---------------|
+| `test_generators.py` | Each generator (database, API models, routes, tests, enums, constraints, infrastructure), immutable entities |
+| `test_edge_cases.py` | JSON comments, invalid input, config loading, deep merge, shared enums/constraints, file scanners, partial generation |
+| `test_wizard.py` | Wizard imports, prompt fallbacks, menu flow, project setup, clean and test runner actions |
+| `test_template_utils.py` | `path_to_import`, `wrap_text`, template environment, custom Jinja2 filters |
+| `test_cli.py` | CLI flags: `--interactive`, `--clear-only`, `--dry-run`, `--diff`, missing model |
+| `test_full_generation.py` | End-to-end generation from example project |
+| `test_integration.py` | Full generation pipeline |
+| `test_validation.py` | JSON schema validation |
+| `test_utils.py` | Utility functions |
+
+## Philosophy
+
+Define specifications once in JSON. Generate production-ready scaffolds. Then maintain and evolve manually. The generated code is yours — no lock-in, no regeneration, full control.
+
+---
+
+**Model Generator** | Bootstrap Tool for API Backends | v0.1.0

model_generator_kit-0.1.0/README.md

@@ -0,0 +1,107 @@
+# Model Generator
+
+A **one-shot bootstrap code generator** that turns JSON specifications into production-ready API backends — database models, API endpoints, tests, and migrations. The generator is stack-agnostic by design; it currently ships the **`python-fastapi`** stack (chosen with `--stack`, the default).
+
+## What It Does
+
+- **Database models** — SQLAlchemy ORM with constraints, relationships, and indexes
+- **API models** — Pydantic request/response schemas with validators
+- **API routes** — FastAPI CRUD endpoints
+- **Tests** — pytest contract tests with FactoryBoy factories (a full contract suite in the example project)
+- **Migrations** — Alembic infrastructure
+
+## Install
+
+`model-generator` is a build-time scaffolding tool, not a runtime dependency of
+the backends it generates. Install it as an isolated global CLI:
+
+```bash
+uv tool install model-generator-kit     # or: pipx install model-generator-kit
+```
+
+This puts `model-gen` and `model-val` on your PATH. For the interactive wizard,
+add the extra: `uv tool install "model-generator-kit[interactive]"`.
+
+> The PyPI package is `model-generator-kit` (the name `model-generator` was already
+> taken); the commands it installs are `model-gen` and `model-val`.
+
+## Quick Start
+
+```bash
+# In any project directory, scaffold from your JSON specs
+model-gen models/ --target all
+
+model-gen --version    # confirm the install
+```
+
+To try the bundled example from a clone of this repo:
+
+```bash
+git clone https://github.com/nuncaeslupus/model-generator && cd model-generator
+uv sync --extra dev
+cd examples/user-auth-project
+uv run model-gen models/ --target all
+uv venv && uv sync --extra dev
+uv run pytest  # the generated contract suite passes
+```
+
+For your own project, see the [Installation Guide](./docs/user/installation.md).
+
+## Documentation
+
+### For Users
+
+- **[Installation Guide](./docs/user/installation.md)** — Install, configure, first project
+- **[Model Design Guide](./docs/user/model-design-guide.md)** — How to design comprehensive JSON specifications
+- **[Usage Guide](./docs/user/usage-guide.md)** — CLI workflows, generation, cleanup, interactive mode
+- **[Quick Reference](./docs/user/quick-reference.md)** — Lookup tables: field types, constraints, options
+- **[Extending Generated Code](./docs/user/extending-generated-code.md)** — Business logic, custom routes, migrations
+
+### For Agents
+
+- **[Model Design Questions](./docs/agent/model-design-questions.md)** — Systematic Q&A for eliciting model specs from users
+- **[Template Extension Guide](./docs/agent/template-extension-guide.md)** — Add types, templates, generators
+- **[JSON Specification Reference](./docs/agent/json-specification-reference.md)** — Exact format, every key, every option
+
+### Deep Dives
+
+- **[Constraints](./docs/deep-dives/constraints.md)** — DB vs API constraint placement, cross-field constraints
+- **[Completeness Guide](./docs/deep-dives/completeness-guide.md)** — JSON specification checklist
+- **[Custom Tests](./docs/deep-dives/custom-tests.md)** — Extending the generated test suite
+
+### For Contributors
+
+- **[Skill Reusability](./docs/contributor/skill-reusability.md)** — Core principles for reusable generation
+- **[Project-Agnostic Rules](./docs/contributor/project-agnostic-rules.md)** — Coding rules for templates and scripts
+
+## Development
+
+```bash
+# Install in editable mode with dev dependencies
+uv sync --extra dev
+
+# Run the test suite
+uv run pytest tests/ -v
+```
+
+### Test Suite
+
+| File | What It Covers |
+|------|---------------|
+| `test_generators.py` | Each generator (database, API models, routes, tests, enums, constraints, infrastructure), immutable entities |
+| `test_edge_cases.py` | JSON comments, invalid input, config loading, deep merge, shared enums/constraints, file scanners, partial generation |
+| `test_wizard.py` | Wizard imports, prompt fallbacks, menu flow, project setup, clean and test runner actions |
+| `test_template_utils.py` | `path_to_import`, `wrap_text`, template environment, custom Jinja2 filters |
+| `test_cli.py` | CLI flags: `--interactive`, `--clear-only`, `--dry-run`, `--diff`, missing model |
+| `test_full_generation.py` | End-to-end generation from example project |
+| `test_integration.py` | Full generation pipeline |
+| `test_validation.py` | JSON schema validation |
+| `test_utils.py` | Utility functions |
+
+## Philosophy
+
+Define specifications once in JSON. Generate production-ready scaffolds. Then maintain and evolve manually. The generated code is yours — no lock-in, no regeneration, full control.
+
+---
+
+**Model Generator** | Bootstrap Tool for API Backends | v0.1.0

model_generator_kit-0.1.0/pyproject.toml

@@ -0,0 +1,112 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "model-generator-kit"
+version = "0.1.0"
+description = "One-shot bootstrap generator for database models, API models, routes, and tests"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.11"
+authors = [
+    { name = "nuncaeslupus", email = "imarcos@gmail.com" }
+]
+keywords = ["generator", "code-generator", "fastapi", "sqlalchemy", "pydantic", "boilerplate"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Code Generators",
+]
+dependencies = [
+    "jinja2>=3.0.0",
+    "pyyaml>=6.0.0",
+    "jsonschema>=4.0.0",
+]
+
+[project.optional-dependencies]
+interactive = [
+    "questionary>=2.0.0",
+]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "questionary>=2.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+    "types-PyYAML>=6.0.0",
+    "types-jsonschema>=4.0.0",
+    "mutmut>=2.4.0",
+    "sqlalchemy>=2.0",
+    "build>=1.0.0",
+    "twine>=4.0.0",
+]
+
+[project.scripts]
+model-gen = "model_generator.generate:main"
+model-val = "model_generator.validate:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+model_generator = ["py.typed", "schema/*.json", "stacks/**/*.yaml", "stacks/**/*.j2"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+exclude = [".claude/"]
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "--strict-markers --tb=short"
+markers = [
+    "slow: marks tests as slow",
+    "integration: marks tests as integration tests",
+    "unit: marks tests as unit tests",
+    "cli: marks tests as CLI tests",
+]
+
+[tool.mypy]
+python_version = "3.11"
+mypy_path = "src"
+strict = true
+warn_unused_configs = true
+warn_no_return = true
+show_error_codes = true
+exclude = [".claude/", "examples/", "tmp/"]
+
+[tool.pyright]
+include = ["src", "tests"]
+exclude = ["**/.venv", "**/node_modules", "**/__pycache__", "**/.*", "examples", "tmp"]
+typeCheckingMode = "standard"
+pythonVersion = "3.11"
+
+[tool.mutmut]
+paths_to_mutate = ["src/model_generator/"]
+tests_dir = ["tests/"]
+also_copy = ["examples/"]
+backup = false
+
+[dependency-groups]
+dev = [
+    "pyyaml>=6.0.3",
+]

model_generator_kit-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

model_generator_kit-0.1.0/src/model_generator/__init__.py

@@ -0,0 +1,6 @@
+"""Model Generator — one-shot bootstrap code generator for FastAPI backends."""
+
+# Single source of truth is pyproject.toml's [project].version. `make
+# version-sync` propagates that value here; `make check-version-sync` (run in
+# CI) fails the build if they drift. Do not edit by hand.
+__version__ = "0.1.0"