Add update command and shell completion

Author: dbanty

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix mypy issue in generated models `from_dict` with datetime or reference properties
 - Generated clients now raise an `ApiResponseError` if they receive a response that was not declared
 - Stop including optional query parameters when value is set to None
+- Added an `update` command to update a previously generated client
+- Added click-completion for installable tab completion in most shells
 
 ## 0.1.0 - 2020-02-28
 - Initial Release

README.md

@@ -21,13 +21,19 @@ using it (Python developers).
 ## Installation
 `pip install openapi-python-client`
 
+Then, if you want tab completion: `openapi-python-client --install-completion`
+
 ## Usage
+### Create a new client
 `openapi-python-client generate --url https://my.api.com/openapi.json`
 
 This will generate a new client library named based on the title in your OpenAPI spec.  For example, if the title 
 of your API is "My API", the expected output will be "my-api-client".  If a folder already exists by that name, you'll 
 get an error.
 
+### Update an existing client
+`openapi-python-client update --url https://my.api.com/openapi.json`
+
 ## What You Get
 1. A `pyproject.toml` file with some basic metadata intended to be used with [Poetry].
 1. A `README.md` you'll most definitely need to update with your project's details

openapi_python_client/__init__.py

@@ -1,5 +1,8 @@
 """ Generate modern Python clients from OpenAPI """
+from __future__ import annotations
+
 import json
+import shutil
 from pathlib import Path
 from typing import Any, Dict, Optional
 
@@ -9,14 +12,24 @@
 from .openapi_parser import OpenAPI, import_string_from_reference
 
 
-def main(*, url: Optional[str], path: Optional[Path]) -> None:
-    """ Generate the client library """
+def _get_project_for_url_or_path(url: Optional[str], path: Optional[Path]) -> _Project:
     data_dict = _get_json(url=url, path=path)
     openapi = OpenAPI.from_dict(data_dict)
-    project = _Project(openapi=openapi)
+    return _Project(openapi=openapi)
+
+
+def create_new_client(*, url: Optional[str], path: Optional[Path]) -> None:
+    """ Generate the client library """
+    project = _get_project_for_url_or_path(url=url, path=path)
     project.build()
 
 
+def update_existing_client(*, url: Optional[str], path: Optional[Path]) -> None:
+    """ Update an existing client library """
+    project = _get_project_for_url_or_path(url=url, path=path)
+    project.update()
+
+
 def _get_json(*, url: Optional[str], path: Optional[Path]) -> Dict[str, Any]:
     json_bytes: bytes
     if url is not None and path is not None:
@@ -41,29 +54,44 @@ def __init__(self, *, openapi: OpenAPI) -> None:
 
         self.package_name: str = self.project_name.replace("-", "_")
         self.package_dir: Path = self.project_dir / self.package_name
+        self.package_description = f"A client library for accessing {self.openapi.title}"
 
     def build(self) -> None:
         """ Create the project from templates """
+
         print(f"Generating {self.project_name}")
         self.project_dir.mkdir()
-        self.package_dir.mkdir()
+        self._create_package()
         self._build_metadata()
         self._build_models()
         self._build_api()
 
-    def _build_metadata(self) -> None:
+    def update(self) -> None:
+        """ Update an existing project """
+
+        if not self.package_dir.is_dir():
+            raise FileNotFoundError()
+        print(f"Updating {self.project_name}")
+        shutil.rmtree(self.package_dir)
+        self._create_package()
+        self._build_models()
+        self._build_api()
+
+    def _create_package(self) -> None:
+        self.package_dir.mkdir()
         # Package __init__.py
         package_init = self.package_dir / "__init__.py"
-        package_description = f"A client library for accessing {self.openapi.title}"
+
         package_init_template = self.env.get_template("package_init.pyi")
-        package_init.write_text(package_init_template.render(description=package_description))
+        package_init.write_text(package_init_template.render(description=self.package_description))
 
+    def _build_metadata(self) -> None:
         # Create a pyproject.toml file
         pyproject_template = self.env.get_template("pyproject.toml")
         pyproject_path = self.project_dir / "pyproject.toml"
         pyproject_path.write_text(
             pyproject_template.render(
-                project_name=self.project_name, package_name=self.package_name, description=package_description
+                project_name=self.project_name, package_name=self.package_name, description=self.package_description
             )
         )
 
@@ -72,7 +100,7 @@ def _build_metadata(self) -> None:
         readme_template = self.env.get_template("README.md")
         readme.write_text(
             readme_template.render(
-                project_name=self.project_name, description=package_description, package_name=self.package_name
+                project_name=self.project_name, description=self.package_description, package_name=self.package_name
             )
         )
 

openapi_python_client/cli.py

@@ -3,8 +3,6 @@
 
 import typer
 
-from . import main
-
 app = typer.Typer()
 
 
@@ -20,10 +18,29 @@ def generate(
     path: Optional[pathlib.Path] = typer.Option(None, help="A path to the JSON file"),
 ) -> None:
     """ Generate a new OpenAPI Client library """
+    from . import create_new_client
+
+    if not url and not path:
+        typer.secho("You must either provide --url or --path", fg=typer.colors.RED)
+        raise typer.Exit(code=1)
+    elif url and path:
+        typer.secho("Provide either --url or --path, not both", fg=typer.colors.RED)
+        raise typer.Exit(code=1)
+    create_new_client(url=url, path=path)
+
+
+@app.command()
+def update(
+    url: Optional[str] = typer.Option(None, help="A URL to read the JSON from"),
+    path: Optional[pathlib.Path] = typer.Option(None, help="A path to the JSON file"),
+) -> None:
+    """ Update an existing OpenAPI Client library """
+    from . import update_existing_client
+
     if not url and not path:
         typer.secho("You must either provide --url or --path", fg=typer.colors.RED)
         raise typer.Exit(code=1)
     elif url and path:
         typer.secho("Provide either --url or --path, not both", fg=typer.colors.RED)
         raise typer.Exit(code=1)
-    main(url=url, path=path)
+    update_existing_client(url=url, path=path)

poetry.lock

@@ -21,6 +21,7 @@ jinja2 = "^2.11.1"
 stringcase = "^1.2.0"
 typer = "^0.0.8"
 colorama = {version = "^0.4.3", markers = "sys_platform == 'win32'"}
+click-completion = "^0.5.2"
 
 [tool.poetry.scripts]
 openapi-python-client = "openapi_python_client.cli:app"