Vishesh 'ironeagle' Bangotra
621f10409e
Squash-merge lib-standardisation: adopt repo standards across packaging, tooling, docs, and CI. - standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint) - add py.typed marker, modernize type hints and Google-style docstrings - nest generated docs under docs/lib and docs/mcp; add hand-written wiki - adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate) - promote generated CHANGELOG.md; bump version to 0.0.7
37 lines
1.7 KiB
JSON
37 lines
1.7 KiB
JSON
{
|
|
"module": "openapi_first.cli",
|
|
"content": {
|
|
"path": "openapi_first.cli",
|
|
"docstring": "# Summary\n\nCommand-line interface for FastAPI OpenAPI-first scaffolding utilities.\n\nThis CLI bootstraps OpenAPI-first FastAPI applications from versioned,\nbundled templates packaged with the library.",
|
|
"objects": {
|
|
"DEFAULT_TEMPLATE": {
|
|
"name": "DEFAULT_TEMPLATE",
|
|
"kind": "attribute",
|
|
"path": "openapi_first.cli.DEFAULT_TEMPLATE",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"available_templates": {
|
|
"name": "available_templates",
|
|
"kind": "function",
|
|
"path": "openapi_first.cli.available_templates",
|
|
"signature": "available_templates() -> list[str]",
|
|
"docstring": "Return a list of available application templates.\n\nReturns:\n list[str]:\n Sorted list of template names found in the internal templates directory."
|
|
},
|
|
"copy_template": {
|
|
"name": "copy_template",
|
|
"kind": "function",
|
|
"path": "openapi_first.cli.copy_template",
|
|
"signature": "copy_template(template: str, target_dir: Path) -> None",
|
|
"docstring": "Copy a bundled OpenAPI-first application template into a directory.\n\nArgs:\n template (str):\n Name of the template to copy.\n target_dir (Path):\n Filesystem path where the template should be copied.\n\nRaises:\n FileNotFoundError:\n If the requested template does not exist."
|
|
},
|
|
"main": {
|
|
"name": "main",
|
|
"kind": "function",
|
|
"path": "openapi_first.cli.main",
|
|
"signature": "main() -> None",
|
|
"docstring": null
|
|
}
|
|
}
|
|
}
|
|
} |