quadkit-cli 0.0.3__tar.gz → 0.0.4__tar.gz

quadkit_cli-0.0.4/.gitignore

@@ -0,0 +1,183 @@
+*
+!tests/
+!tests/**
+!README.md
+!AGENTS.md
+!DEVELOPMENT.md
+!QUICKGUIDE.md
+!MILESTONE*.md
+!TESTS*.md
+!CHANGELOG.md
+!AUDIT*.md
+!REF*.md
+!AUDIT*.json
+!LICENSE
+!LICENSE-MIT.txt
+!NOTICE
+!TRADEMARK.md
+!conftest.py
+!CONTRIBUTING.md
+!CODE_OF_CONDUCT.md
+!SECURITY.md
+!GOVERNANCE.md
+!pyproject.toml
+!uv.lock
+!docker-compose.yml
+!.env.example
+!.env.full.example
+!.importlinter
+!.superpowers/
+!.superpowers/**
+!.gitattributes
+!.editorconfig
+!Makefile
+!docker-compose.test.yml
+!quadkit.yaml.example
+!.github/
+!.github/workflows/
+!.github/workflows/**
+!.github/dependabot.yml
+!.devcontainer/
+!.devcontainer/**
+!tools/
+!tools/**
+!*example.yaml
+
+# Quadkit Packages
+!quadkit*/
+!quadkit*/pyproject.toml
+!quadkit*/CHANGELOG.md
+!quadkit*/README.md
+!quadkit*/alembic.ini
+!quadkit*/mypy.ini
+!quadkit*/*.yaml.example
+!quadkit*/src/
+!quadkit*/src/**
+!quadkit*/docs/
+!quadkit*/docs/**
+!quadkit*/tests/
+!quadkit*/tests/**
+
+# Keep quadkit docs
+!/docs/
+!docs/**
+
+# Session / cutover plans at the repo root
+!plans/
+!plans/**
+
+# Keep example files for README examples
+!/examples/
+!/examples/**
+
+# Re-ignore these AFTER negations (last match wins)
+*.tape
+examples/*/runs/
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+test.db
+!quadkit*/tests/fixtures/test.db
+*.log
+*.tmp
+
+# Company-specific files (keep private, do not commit)
+.company/
+COMPANY_*.md
+company-config/
+internal-docs/
+# Editor swap files
+*.swp
+
+!core/
+!packages/
+!core/quadkit*/
+!packages/quadkit*/
+!core/quadkit*/pyproject.toml
+!packages/quadkit*/pyproject.toml
+!core/quadkit*/CHANGELOG.md
+!packages/quadkit*/CHANGELOG.md
+!core/quadkit*/README.md
+!packages/quadkit*/README.md
+!core/quadkit*/alembic.ini
+!packages/quadkit*/alembic.ini
+!core/quadkit*/mypy.ini
+!packages/quadkit*/mypy.ini
+!core/quadkit*/*.yaml.example
+!packages/quadkit*/*.yaml.example
+!core/quadkit*/src/
+!core/quadkit*/src/**
+!packages/quadkit*/src/
+!packages/quadkit*/src/**
+!core/quadkit*/tests/
+!core/quadkit*/tests/**
+!packages/quadkit*/tests/
+!packages/quadkit*/tests/**
+!core/quadkit*/docs/
+!core/quadkit*/docs/**
+!packages/quadkit*/docs/
+!packages/quadkit*/docs/**
+
+# dev/
+!dev/
+!dev/**
+
+# Admin dev playground (committed dev asset; local SQLite files stay ignored)
+!packages/quadkit-admin/playground/
+!packages/quadkit-admin/playground/serve.py
+
+# gatewai apps
+!apps/
+!apps/**
+!apps/gatewai/
+!apps/gatewai/**
+apps/**/node_modules/
+apps/**/dist/
+apps/**/__pycache__/
+apps/**/*.pyc
+apps/**/*.db
+apps/**/*.db-wal
+apps/**/*.db-shm
+
+# Re-exclude private content under the tiered paths.
+# MUST come after the !...docs/** negations above — last match wins.
+core/quadkit*/docs/plans/
+packages/quadkit*/docs/plans/
+core/quadkit*/docs/**/
+packages/quadkit*/docs/**/
+
+# Re-exclude tooling artifacts under the tiered paths
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+test.db
+*.tmp
+*.log
+!core/quadkit*/tests/fixtures/test.db
+!packages/quadkit*/tests/fixtures/test.db
+
+# Allow the generated example gifs to be tracked (README hero images).
+!core/quadkit*/docs/gifs/
+!core/quadkit*/docs/gifs/**
+!packages/*/quadkit*/docs/gifs/
+!packages/*/quadkit*/docs/gifs/**
+examples/*/screenshot.png
+!banner*

{quadkit_cli-0.0.3 → quadkit_cli-0.0.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.5
 Name: quadkit-cli
-Version: 0.0.3
+Version: 0.0.4
 Summary: Command-line interface for Quadkit Framework - Project scaffolding, code generation, and development tools
-Project-URL: Homepage, https://quadkit.dev
+Project-URL: Homepage, https://dbtinoy-.github.io/quadkit/
 Project-URL: Repository, https://github.com/dbtinoy-/quadkit
-Project-URL: Documentation, https://quadkit.dev
+Project-URL: Documentation, https://dbtinoy-.github.io/quadkit/
 Project-URL: Issues, https://github.com/dbtinoy-/quadkit/issues
 Project-URL: Changelog, https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md
 Author-email: Quadkit Framework Team <team@quadkit.dev>
@@ -26,36 +26,42 @@ Classifier: Topic :: Software Development :: Code Generators
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.11
-Requires-Dist: aiofiles>=23.0.0
-Requires-Dist: httpx>=0.25.0
-Requires-Dist: jinja2>=3.1.0
-Requires-Dist: pydantic>=2.10.0
-Requires-Dist: pyyaml>=6.0
+Requires-Dist: aiofiles<26,>=23.0.0
+Requires-Dist: click<9,>=8.1.0
+Requires-Dist: httpx<1,>=0.25.0
+Requires-Dist: jinja2<4,>=3.1.0
+Requires-Dist: pyyaml<7,>=6.0
 Requires-Dist: quadkit-contracts>=0.0.2
 Requires-Dist: quadkit>=0.0.2
-Requires-Dist: rich>=13.0.0
-Requires-Dist: shellingham>=1.5.0
-Requires-Dist: tomli>=2.0.0
-Requires-Dist: typer[all]>=0.9.0
-Requires-Dist: watchfiles>=0.21.0
+Requires-Dist: rich<14,>=13.0.0
+Requires-Dist: shellingham<2,>=1.5.0
+Requires-Dist: tomli<3,>=2.0.0
+Requires-Dist: typer[all]<1,>=0.9.0
+Requires-Dist: watchfiles<2,>=0.21.0
 Provides-Extra: all
-Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
-Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
-Requires-Dist: pytest>=8.0.0; extra == 'all'
+Requires-Dist: pytest-asyncio<2,>=0.21.0; extra == 'all'
+Requires-Dist: pytest-cov<8,>=4.0.0; extra == 'all'
+Requires-Dist: pytest<10,>=8.0.0; extra == 'all'
 Requires-Dist: quadkit-testing>=0.0.2; extra == 'all'
 Provides-Extra: dev
-Requires-Dist: black>=23.0.0; extra == 'dev'
-Requires-Dist: mypy>=1.0.0; extra == 'dev'
-Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: black<27,>=23.0.0; extra == 'dev'
+Requires-Dist: mypy<3,>=1.0.0; extra == 'dev'
+Requires-Dist: ruff<1,>=0.1.0; extra == 'dev'
 Provides-Extra: test
-Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
-Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
-Requires-Dist: pytest>=8.0.0; extra == 'test'
+Requires-Dist: pytest-asyncio<2,>=0.21.0; extra == 'test'
+Requires-Dist: pytest-cov<8,>=4.0.0; extra == 'test'
+Requires-Dist: pytest<10,>=8.0.0; extra == 'test'
 Requires-Dist: quadkit-testing>=0.0.2; extra == 'test'
 Description-Content-Type: text/markdown
 
 # quadkit-cli
 
+![Quadkit](https://raw.githubusercontent.com/dbtinoy-/quadkit/main/banner.jpg)
+
+[![PyPI](https://img.shields.io/pypi/v/quadkit-cli?color=%2322c55e&label=pypi)](https://pypi.org/project/quadkit-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/quadkit-cli?color=%2322c55e)](https://pypi.org/project/quadkit-cli/)
+[![License](https://img.shields.io/pypi/l/quadkit-cli?color=%2322c55e)](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE)
+
 The `quadkit` command line: project scaffolding, generators, a smart
 runner, and administrative commands for every stage of the application
 lifecycle. Contributor-based — other packages can register their own
@@ -63,6 +69,16 @@ commands.
 
 For day-to-day Quadkit developers: scaffold, generate, run, inspect.
 
+## The quadkit family
+
+| Package | Role |
+| --- | --- |
+| [`quadkit-contracts`](https://pypi.org/project/quadkit-contracts/) | zero-dependency protocols, types, exception hierarchy |
+| [`quadkit`](https://pypi.org/project/quadkit/) | the framework core — DI container, modules, config, logging, `Result` |
+| [`quadkit-web`](https://pypi.org/project/quadkit-web/) | ASGI layer — controllers, routing, middleware, OpenAPI docs |
+| [`quadkit-cli`](https://pypi.org/project/quadkit-cli/) | project scaffolding and code generators |
+| [`quadkit-testing`](https://pypi.org/project/quadkit-testing/) | in-process test beds, fakes, fixtures |
+
 ## Installation
 
 ```bash
@@ -78,15 +94,24 @@ Requires **Python >= 3.11**.
 There is no code to write — the product is the command line:
 
 ```bash
-# Create a new project (template defaults to web-api)
+# Create a new project (template defaults to web-api); the package
+# inside is my_api/ with app.py exposing create_app()
 quadkit new project my-api
+cd my-api
 
 # Generate application code (list all generators: quadkit gen list)
 quadkit gen provider MyProvider
 quadkit gen controller Orders
 
 # Serve the application; reload is on by default, pass --no-reload in prod
-quadkit run my_app.app:create_app --host 0.0.0.0 --port 8000 --workers 4
+quadkit run my_api.app:create_app --host 0.0.0.0 --port 8000 --workers 4
+```
+
+Eleven generators ship today (`quadkit gen list`):
+
+```text
+controller  middleware  graphql  webhook  websocket  exception_filter
+interceptor  error  resource  provider  test
 ```
 
 Global options: `--json` for machine-readable output, `--quiet`,
@@ -110,18 +135,16 @@ Global options: `--json` for machine-readable output, `--quiet`,
 | `quadkit version` | framework and package versions |
 
 Per-distribution guide:
-[quadkit-cli reference](../../docs/reference/quadkit-cli.md).
+[quadkit-cli reference](https://dbtinoy-.github.io/quadkit/reference/quadkit-cli/).
 
 ## Optional extras
 
-Verified against the package's `pyproject.toml`: `[dev]`, `[test]`,
-`[all]`.
+`[dev]` and `[test]` bundle tooling; `[all]` pulls everything.
 
 ## Configuration
 
 The CLI reads `application.yaml` like any Quadkit application; its own
-section is `cli` (fields include `default_template`, `default_database`,
-`color`, `verbose`), overridable via `QK_CLI__*`, e.g.
+section is `cli` (`color`), overridable via `QK_CLI__*`, e.g.
 `QK_CLI__COLOR=false`.
 
 ## Error handling
@@ -140,7 +163,7 @@ exported tree.
 The CLI reads configuration and scaffolds code — it does not serve
 traffic. As with every distribution, keep the `0.x` line pinned and
 review release notes on upgrade. Report vulnerabilities privately per
-[SECURITY.md](../../SECURITY.md).
+[SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md).
 
 ## Stability
 
@@ -148,6 +171,17 @@ Version `0.0.3` in the `0.x` series, released in lockstep with the
 other four distributions; APIs may change between minor versions until
 1.0 — pin an exact version (`quadkit-cli==0.0.3`) or a tight range
 (`>=0.0.3,<0.1.0`). Full policy:
-[stability and compatibility](../../docs/reference/stability.md).
+[stability and compatibility](https://dbtinoy-.github.io/quadkit/reference/stability/).
+
+## Links
+
+- **Documentation** — <https://dbtinoy-.github.io/quadkit/>
+- **Getting started** — <https://dbtinoy-.github.io/quadkit/getting-started/installation/>
+- **Changelog** — <https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md>
+- **Issues** — <https://github.com/dbtinoy-/quadkit/issues>
+- **Security** — report privately per [SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md)
+- **Contributing** — [CONTRIBUTING.md](https://github.com/dbtinoy-/quadkit/blob/main/CONTRIBUTING.md)
 
-Issues: <https://github.com/dbtinoy-/quadkit/issues>
+Apache-2.0 — see [LICENSE](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE). "Quadkit" and the
+Quadkit logo are trademarks of the project — see
+[TRADEMARK.md](https://github.com/dbtinoy-/quadkit/blob/main/TRADEMARK.md).

{quadkit_cli-0.0.3 → quadkit_cli-0.0.4}/README.md

@@ -1,5 +1,11 @@
 # quadkit-cli
 
+![Quadkit](https://raw.githubusercontent.com/dbtinoy-/quadkit/main/banner.jpg)
+
+[![PyPI](https://img.shields.io/pypi/v/quadkit-cli?color=%2322c55e&label=pypi)](https://pypi.org/project/quadkit-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/quadkit-cli?color=%2322c55e)](https://pypi.org/project/quadkit-cli/)
+[![License](https://img.shields.io/pypi/l/quadkit-cli?color=%2322c55e)](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE)
+
 The `quadkit` command line: project scaffolding, generators, a smart
 runner, and administrative commands for every stage of the application
 lifecycle. Contributor-based — other packages can register their own
@@ -7,6 +13,16 @@ commands.
 
 For day-to-day Quadkit developers: scaffold, generate, run, inspect.
 
+## The quadkit family
+
+| Package | Role |
+| --- | --- |
+| [`quadkit-contracts`](https://pypi.org/project/quadkit-contracts/) | zero-dependency protocols, types, exception hierarchy |
+| [`quadkit`](https://pypi.org/project/quadkit/) | the framework core — DI container, modules, config, logging, `Result` |
+| [`quadkit-web`](https://pypi.org/project/quadkit-web/) | ASGI layer — controllers, routing, middleware, OpenAPI docs |
+| [`quadkit-cli`](https://pypi.org/project/quadkit-cli/) | project scaffolding and code generators |
+| [`quadkit-testing`](https://pypi.org/project/quadkit-testing/) | in-process test beds, fakes, fixtures |
+
 ## Installation
 
 ```bash
@@ -22,15 +38,24 @@ Requires **Python >= 3.11**.
 There is no code to write — the product is the command line:
 
 ```bash
-# Create a new project (template defaults to web-api)
+# Create a new project (template defaults to web-api); the package
+# inside is my_api/ with app.py exposing create_app()
 quadkit new project my-api
+cd my-api
 
 # Generate application code (list all generators: quadkit gen list)
 quadkit gen provider MyProvider
 quadkit gen controller Orders
 
 # Serve the application; reload is on by default, pass --no-reload in prod
-quadkit run my_app.app:create_app --host 0.0.0.0 --port 8000 --workers 4
+quadkit run my_api.app:create_app --host 0.0.0.0 --port 8000 --workers 4
+```
+
+Eleven generators ship today (`quadkit gen list`):
+
+```text
+controller  middleware  graphql  webhook  websocket  exception_filter
+interceptor  error  resource  provider  test
 ```
 
 Global options: `--json` for machine-readable output, `--quiet`,
@@ -54,18 +79,16 @@ Global options: `--json` for machine-readable output, `--quiet`,
 | `quadkit version` | framework and package versions |
 
 Per-distribution guide:
-[quadkit-cli reference](../../docs/reference/quadkit-cli.md).
+[quadkit-cli reference](https://dbtinoy-.github.io/quadkit/reference/quadkit-cli/).
 
 ## Optional extras
 
-Verified against the package's `pyproject.toml`: `[dev]`, `[test]`,
-`[all]`.
+`[dev]` and `[test]` bundle tooling; `[all]` pulls everything.
 
 ## Configuration
 
 The CLI reads `application.yaml` like any Quadkit application; its own
-section is `cli` (fields include `default_template`, `default_database`,
-`color`, `verbose`), overridable via `QK_CLI__*`, e.g.
+section is `cli` (`color`), overridable via `QK_CLI__*`, e.g.
 `QK_CLI__COLOR=false`.
 
 ## Error handling
@@ -84,7 +107,7 @@ exported tree.
 The CLI reads configuration and scaffolds code — it does not serve
 traffic. As with every distribution, keep the `0.x` line pinned and
 review release notes on upgrade. Report vulnerabilities privately per
-[SECURITY.md](../../SECURITY.md).
+[SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md).
 
 ## Stability
 
@@ -92,6 +115,17 @@ Version `0.0.3` in the `0.x` series, released in lockstep with the
 other four distributions; APIs may change between minor versions until
 1.0 — pin an exact version (`quadkit-cli==0.0.3`) or a tight range
 (`>=0.0.3,<0.1.0`). Full policy:
-[stability and compatibility](../../docs/reference/stability.md).
+[stability and compatibility](https://dbtinoy-.github.io/quadkit/reference/stability/).
+
+## Links
+
+- **Documentation** — <https://dbtinoy-.github.io/quadkit/>
+- **Getting started** — <https://dbtinoy-.github.io/quadkit/getting-started/installation/>
+- **Changelog** — <https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md>
+- **Issues** — <https://github.com/dbtinoy-/quadkit/issues>
+- **Security** — report privately per [SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md)
+- **Contributing** — [CONTRIBUTING.md](https://github.com/dbtinoy-/quadkit/blob/main/CONTRIBUTING.md)
 
-Issues: <https://github.com/dbtinoy-/quadkit/issues>
+Apache-2.0 — see [LICENSE](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE). "Quadkit" and the
+Quadkit logo are trademarks of the project — see
+[TRADEMARK.md](https://github.com/dbtinoy-/quadkit/blob/main/TRADEMARK.md).