Commit Graph

19 Commits

Author SHA1 Message Date
a3c063b569 docs(templates): document CRUD and model CRUD apps and expose them in mkdocs
- Add comprehensive module and function docstrings to crud_app and model_app templates
- Document OpenAPI-first guarantees, non-goals, and usage patterns in templates
- Add template-level __init__.py files with CLI and client usage examples
- Update mkdocs.yml to include CRUD and model-based CRUD template documentation
- Ensure template documentation follows strict package-bound mkdocstrings rules
2026-01-11 21:42:30 +05:30
72b5be6976 docs, cli: enforce package-bound docs, add template scaffolding, and document CLI usage
- Restrict mkdocstrings generation to real Python packages (require __init__.py)
- Add explicit documentation section for CLI scaffolding and templates
- Generalize CLI to support multiple templates with dynamic discovery
- Package templates correctly for importlib.resources access
- Add fully documented health_app template (app entry point and handlers)
- Fix setuptools package-data configuration for bundled templates

These changes make documentation import-safe, clarify package boundaries,
and provide a deterministic, OpenAPI-first scaffolding workflow via CLI.
2026-01-11 19:26:21 +05:30
6180443327 v0.0.3 — Introduces an OpenAPI-first HTTP client, updates documentation and templates to use operationId-based calls, and adds httpx as a client-side dependency.
All checks were successful
continuous-integration/drone/tag Build is passing
0.0.3
2026-01-11 18:43:04 +05:30
1b26021725 added explicitly httpx as it's being used in client.py 2026-01-11 18:42:13 +05:30
a74e3d0d01 Introduce an OpenAPI-first HTTP client driven by the same specification
used for server-side route binding, and refactor documentation and
templates to treat the client as a first-class contract consumer.

Key changes:
- Add OpenAPI-first client module based on httpx
- Document client usage alongside server-side binder usage
- Update mkdocs navigation to include client documentation
- Refactor CRUD and model app templates to call APIs via operationId
  instead of hardcoded paths
- Align package documentation and public API surface with client support
- Clarify server/client dependency split (fastapi vs httpx)

This establishes strict symmetry between OpenAPI-driven server binding
and OpenAPI-driven client invocation, reinforcing OpenAPI as the single
source of truth on both sides of the contract.
2026-01-11 18:41:27 +05:30
31bf1b1b6b cleanup requirements.txt 2026-01-11 17:12:03 +05:30
7b4583f305 feat(templates): add CRUD and model CRUD app scaffolds; bump version to 0.0.2
All checks were successful
continuous-integration/drone/tag Build is passing
- add OpenAPI-first CRUD app template with in-memory mock data
- add model-based CRUD app template with Pydantic layer
- include end-to-end tests for both templates
- document explicit runtime status handling in routes
- add Pydantic dependency for model_app support
0.0.2
2026-01-10 18:07:01 +05:30
fc8346fcda added pydantic with pin 2026-01-10 18:05:51 +05:30
40d91bc52b feat(scaffold): add model-backed CRUD service template
Provides a complete OpenAPI-first CRUD example with a Pydantic
model layer, explicit runtime semantics, and integration tests
to support developer onboarding and real-world service structure.
2026-01-10 18:05:39 +05:30
2ac342240b feat(templates): add OpenAPI-first CRUD app scaffold with mock data
- include CRUD OpenAPI spec
- add in-memory mock data store
- implement OpenAPI-bound route handlers
- provide runnable FastAPI bootstrap
- include end-to-end integration test
2026-01-10 17:59:11 +05:30
2f444a93ad doc changes from fastapi openapi first to openapi first. added cli docs
All checks were successful
continuous-integration/drone/tag Build is passing
0.0.1
2026-01-10 17:43:52 +05:30
571a11a1c7 feat(cli): add bundled health app scaffold and init command
- ship OpenAPI-first health check template as package data
- add CLI to copy scaffold into new project directories
- include OpenAPI spec, routes, and bootstrap example
- enable fast startup for OpenAPI-first services
2026-01-10 17:39:33 +05:30
20f65d22e0 fixed tags 2026-01-10 17:32:03 +05:30
7a7923910b added .drone.yml 2026-01-10 17:22:14 +05:30
3d1cdcba4c added toml file 2026-01-10 17:22:03 +05:30
8a90e10acc added manage_docs.py and docs folder 2026-01-10 17:21:54 +05:30
f25762685b added requirements for docs and pytest 2026-01-10 17:21:39 +05:30
b88ecbd7c5 init openapi_first 2026-01-10 17:21:21 +05:30
76e2599903 init 2026-01-10 17:21:06 +05:30