quadkit-cli 0.0.1__tar.gz → 0.0.2__tar.gz

quadkit_cli-0.0.2/.gitignore

@@ -0,0 +1,190 @@
+*
+!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/**
+!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
+
+# Tiered package layout (core/, packages/, experimental/<family>/)
+!core/
+!packages/
+!experimental/
+!experimental/*/
+!core/quadkit*/
+!packages/quadkit*/
+!experimental/*/quadkit*/
+!core/quadkit*/pyproject.toml
+!packages/quadkit*/pyproject.toml
+!experimental/*/quadkit*/pyproject.toml
+!core/quadkit*/CHANGELOG.md
+!packages/quadkit*/CHANGELOG.md
+!experimental/*/quadkit*/CHANGELOG.md
+!core/quadkit*/README.md
+!packages/quadkit*/README.md
+!experimental/*/quadkit*/README.md
+!core/quadkit*/alembic.ini
+!packages/quadkit*/alembic.ini
+!experimental/*/quadkit*/alembic.ini
+!core/quadkit*/mypy.ini
+!packages/quadkit*/mypy.ini
+!experimental/*/quadkit*/mypy.ini
+!core/quadkit*/*.yaml.example
+!packages/quadkit*/*.yaml.example
+!experimental/*/quadkit*/*.yaml.example
+!core/quadkit*/src/
+!core/quadkit*/src/**
+!packages/quadkit*/src/
+!packages/quadkit*/src/**
+!experimental/*/quadkit*/src/
+!experimental/*/quadkit*/src/**
+!core/quadkit*/tests/
+!core/quadkit*/tests/**
+!packages/quadkit*/tests/
+!packages/quadkit*/tests/**
+!experimental/*/quadkit*/tests/
+!experimental/*/quadkit*/tests/**
+!core/quadkit*/docs/
+!core/quadkit*/docs/**
+!packages/quadkit*/docs/
+!packages/quadkit*/docs/**
+!experimental/*/quadkit*/docs/
+!experimental/*/quadkit*/docs/**
+
+# dev/
+!dev/
+!dev/**
+
+# Admin dev playground (committed dev asset; local SQLite files stay ignored)
+!experimental/*/quadkit*/playground/
+!experimental/*/quadkit*/playground/**
+experimental/*/quadkit*/playground/*.db
+experimental/*/quadkit*/playground/*.db-*
+
+# 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/
+experimental/*/quadkit*/docs/plans/
+core/quadkit*/docs/**/
+packages/quadkit*/docs/**/
+experimental/*/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
+!experimental/*/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/**
+!experimental/*/quadkit*/docs/gifs/
+!experimental/*/quadkit*/docs/gifs/**
+examples/*/screenshot.png

quadkit_cli-0.0.2/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

quadkit_cli-0.0.2/NOTICE

@@ -0,0 +1,35 @@
+Quadkit Framework
+Copyright 2026 Quadkit
+
+This product includes software developed by the Quadkit Framework project.
+
+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 in the LICENSE file at the root of this repository, or 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.
+
+--------------------------------------------------------------------------
+Prior licensing
+--------------------------------------------------------------------------
+
+The 0.0.1 release of this project was distributed under the MIT License.
+That license text is retained in LICENSE-MIT.txt and continues to apply to
+that release. It does not apply to this or any later version.
+
+--------------------------------------------------------------------------
+Trademarks
+--------------------------------------------------------------------------
+
+"Quadkit" and the Quadkit logo are trademarks of the Quadkit project and
+are not licensed under the Apache License, Version 2.0. See TRADEMARK.md for
+the trademark policy.
+
+Quadkit is not affiliated with, endorsed by, or sponsored by any third
+party whose marks may resemble the project name.

quadkit_cli-0.0.2/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.5
+Name: quadkit-cli
+Version: 0.0.2
+Summary: Command-line interface for Quadkit Framework - Project scaffolding, code generation, and development tools
+Project-URL: Homepage, https://quadkit.dev
+Project-URL: Repository, https://github.com/dbtinoy-/quadkit
+Project-URL: Documentation, https://quadkit.dev
+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>
+Maintainer-email: Quadkit Framework Team <team@quadkit.dev>
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: cli,codegen,command-line,devtools,framework,scaffolding
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+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: 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
+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: 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'
+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: quadkit-testing>=0.0.2; extra == 'test'
+Description-Content-Type: text/markdown
+
+# quadkit-cli
+
+Command-line interface for the Quadkit Framework.
+
+---
+
+## Overview
+
+The `quadkit` CLI provides project scaffolding, code generation, development tooling, and administrative commands for every stage of the application lifecycle. It uses a contributor-based plugin system so other packages can extend the CLI with new commands and generators.
+
+> Full documentation: [docs.quadkit.dev](https://docs.quadkit.dev)
+## Install
+
+```bash
+uv add quadkit-cli
+# or, as a standalone tool:
+uv tool install quadkit-cli
+```
+
+## Quick Start
+
+```python
+from quadkit import Application
+from quadkit.di.module import Module, module
+
+from quadkit.cli import CLIModule
+from quadkit.cli.config import CLIConfig
+
+
+@module(imports=[CLIModule.configure(CLIConfig())])
+class AppModule(Module):
+    pass
+
+
+async with Application.boot(modules=[AppModule]) as app:
+    # use app.container to resolve services
+    ...
+```
+
+Or use the CLI directly:
+
+```bash
+# Create a new web API project
+quadkit new project my-api --template web-api
+
+# Scaffold a new extension package
+quadkit new package my-feature
+
+# Generate a provider (providers and tests are the built-in generators)
+quadkit gen provider MyProvider
+
+# Add the database package to an existing project
+quadkit add database
+
+# Start the dev server with hot-reload
+quadkit dev start
+```
+
+## Configuration
+
+> **Zero-config usage:** Call `CLIModule.configure()` with no arguments to use all defaults.
+
+### Option 1 — YAML file
+
+```yaml
+# application.yaml
+cli:
+  default_template: "web-api"
+  default_database: "postgres"
+  color: true
+  verbose: false
+```
+
+### Option 2 — Profiles + Environment Variables *(recommended)*
+
+```bash
+export QK_CLI__DEFAULT_TEMPLATE=web-api
+export QK_CLI__COLOR=true
+export QK_CLI__VERBOSE=false
+```
+
+### Option 3 — Python
+
+```python
+from quadkit.cli.config import CLIConfig
+from quadkit.cli import CLIModule
+
+config = CLIConfig.from_env_profile()
+CLIModule.configure(config)
+```
+
+### Config reference
+
+| Field | Default | Env var | Description |
+|-------|---------|---------|-------------|
+| `default_template` | `"web-api"` | `QK_CLI__DEFAULT_TEMPLATE` | Template used by `quadkit new` |
+| `default_database` | `"postgres"` | `QK_CLI__DEFAULT_DATABASE` | Database driver used by scaffolding |
+| `color` | `true` | `QK_CLI__COLOR` | Enable coloured terminal output |
+| `verbose` | `false` | `QK_CLI__VERBOSE` | Print verbose/debug output |
+
+## Module Factory Methods
+
+| Method | Description |
+|--------|-------------|
+| `CLIModule.configure(config)` | Register the CLI module and its contributor-based commands |
+| `CLIModule.stub()` | Minimal module for tests |
+
+## Key Features
+
+- **Project scaffolding** — `web-api`, `api`, and `full` templates
+- **Package generation** — scaffold new `quadkit-*` extension packages
+- **Code generators** — `provider` and `test` generators built in; more generators ship as CLI contributors from ecosystem packages (e.g. controllers via `quadkit-web`)
+- **Contributor system** — extensible plugin architecture for new commands
+- **Shell completion** — bash, zsh, and fish completion scripts
+
+## Testing
+
+```python
+from quadkit import Application
+from quadkit.cli import CLIModule
+
+
+async def test_cli_module():
+    async with Application.boot(modules=[CLIModule.stub()]) as app:
+        # No-op CLI module for tests
+        ...
+```
+
+## Key Source Files
+
+| File | What it contains |
+|------|----------------|
+| `src/quadkit/cli/config.py` | `CLIConfig` configuration dataclass |
+| `src/quadkit/cli/module.py` | CLI module assembly |
+| `src/quadkit/cli/commands/` | All CLI command implementations |
+| `src/quadkit/cli/generators/` | Code generation logic |
+| `src/quadkit/cli/registry/` | Registry subsystems |
+| `src/quadkit/cli/contributors/` | Plugin contributor system |