- Removed typer and moved everything to click, due to easier handling of documentation

Author: MarcoMuellner

poetry.lock

@@ -18,7 +18,6 @@ Changelog = "https://github.com/MarcoMuellner/openapi-python-generator/releases"
 [tool.poetry.dependencies]
 python = "^3.7"
 httpx = {extras = ["all"], version = "^0.23.0"}
-typer = "^0.4.1"
 pydantic = "^1.9.1"
 orjson = "^3.7.2"
 openapi-schema-pydantic = "^1.2.3"
@@ -53,7 +52,7 @@ myst-parser = {version = ">=0.16.1"}
 pytest-cov = "^3.0.0"
 
 [tool.poetry.scripts]
-openapi-python-generator = "openapi_python_generator.__main__:app"
+openapi-python-generator = "openapi_python_generator.__main__:main"
 
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]

pyproject.toml

@@ -1 +1,11 @@
-"""Openapi Python Generator."""
+"""The hypermodern Python project."""
+try:
+    from importlib.metadata import version, PackageNotFoundError  # type: ignore
+except ImportError:  # pragma: no cover
+    from importlib_metadata import version, PackageNotFoundError  # type: ignore
+
+
+try:
+    __version__ = version(__name__)
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "unknown"

src/openapi_python_generator/__init__.py

@@ -1,22 +1,33 @@
 from typing import Optional
 
-import typer
+import click
 
+from openapi_python_generator import __version__
 from openapi_python_generator.common import HTTPLibrary
 from openapi_python_generator.generate_data import generate_data
 
-app = typer.Typer()
 
-
-@app.command()
+@click.command()
+@click.argument("source")
+@click.argument("output")
+@click.option(
+    "--library",
+    default=HTTPLibrary.httpx,
+    type=HTTPLibrary,
+    help="HTTP library to use in the generation of the client. Currently only httpx is supported.",
+)
+@click.version_option(version=__version__)
 def main(
-    file_name: str, output: str, library: Optional[HTTPLibrary] = HTTPLibrary.httpx
+    source: str, output: str, library: Optional[HTTPLibrary] = HTTPLibrary.httpx
 ) -> None:
     """
     Generate Python code from an OpenAPI 3.0 specification.
+
+    Provide a SOURCE (file or URL) containing the OpenAPI 3 specification and
+    an OUTPUT path, where the resulting client is created.
     """
-    generate_data(file_name, output, library)
+    generate_data(source, output, library)
 
 
 if __name__ == "__main__":  # pragma: no cover
-    app()
+    main()

src/openapi_python_generator/__main__.py

@@ -1,10 +1,10 @@
 from pathlib import Path
 from typing import Optional, Union
 
+import click
 import httpx
 from httpx import ConnectError, ConnectTimeout
 import orjson
-import typer
 from pydantic import ValidationError
 import autopep8
 
@@ -25,31 +25,31 @@ def write_code(path: Path, content):
         f.write(autopep8.fix_code(content))
 
 
-def get_open_api(path: Union[str, Path]) -> OpenAPI:
+def get_open_api(source: Union[str, Path]) -> OpenAPI:
     """
     Tries to fetch the openapi.json file from the web or load from a local file. Returns the according OpenAPI object.
-    :param path:
+    :param source:
     :return:
     """
     try:
-        if not isinstance(path, Path) and (
-            path.startswith("http://") or path.startswith("https://")
+        if not isinstance(source, Path) and (
+            source.startswith("http://") or source.startswith("https://")
         ):
-            return OpenAPI(**orjson.loads(httpx.get(path).text))
+            return OpenAPI(**orjson.loads(httpx.get(source).text))
 
-        with open(path, "r") as f:
+        with open(source, "r") as f:
             return OpenAPI(**orjson.loads(f.read()))
     except FileNotFoundError:
-        typer.echo(
-            f"File {path} not found. Please make sure to pass the path to the OpenAPI 3.0 specification."
+        click.echo(
+            f"File {source} not found. Please make sure to pass the path to the OpenAPI 3.0 specification."
         )
         raise
     except (ConnectError, ConnectTimeout):
-        typer.echo(f"Could not connect to {path}.")
-        raise ConnectError(f"Could not connect to {path}.") from None
+        click.echo(f"Could not connect to {source}.")
+        raise ConnectError(f"Could not connect to {source}.") from None
     except (ValidationError, orjson.JSONDecodeError):
-        typer.echo(
-            f"File {path} is not a valid OpenAPI 3.0 specification, or there may be a problem with your JSON."
+        click.echo(
+            f"File {source} is not a valid OpenAPI 3.0 specification, or there may be a problem with your JSON."
         )
         raise
 
@@ -114,14 +114,14 @@ def write_data(data: ConversionResult, output: Union[str, Path]):
 
 
 def generate_data(
-    file_name: Union[str, Path],
+    source: Union[str, Path],
     output: Union[str, Path],
     library: Optional[HTTPLibrary] = HTTPLibrary.httpx,
 ) -> None:
     """
     Generate Python code from an OpenAPI 3.0 specification.
     """
-    data = get_open_api(file_name)
-    typer.echo(f"Generating data from {file_name}")
+    data = get_open_api(source)
+    click.echo(f"Generating data from {source}")
     result = generator(data)
     write_data(result, output)

src/openapi_python_generator/generate_data.py

@@ -1,6 +1,6 @@
 from typing import List, Optional, Tuple
 
-import typer
+import click
 from openapi_schema_pydantic import Components, Reference, Schema
 
 from openapi_python_generator.language_converters.python.jinja_config import (
@@ -146,7 +146,7 @@ def generate_models(components: Components) -> List[Model]:
                 compile(m.content, "<string>", "exec")
                 models.append(m)
             except SyntaxError as e:  # pragma: no cover
-                typer.echo(f"Error in model {name}: {e}")
+                click.echo(f"Error in model {name}: {e}")
 
             continue  # pragma: no cover
 
@@ -174,7 +174,7 @@ def generate_models(components: Components) -> List[Model]:
         try:
             compile(generated_content, "<string>", "exec")
         except SyntaxError as e:  # pragma: no cover
-            typer.echo(f"Error in model {name}: {e}")  # pragma: no cover
+            click.echo(f"Error in model {name}: {e}")  # pragma: no cover
 
         models.append(
             Model(

src/openapi_python_generator/language_converters/python/model_generator.py

@@ -1,6 +1,6 @@
 from typing import Dict, List, Tuple, Union
 
-import typer
+import click
 from openapi_schema_pydantic import (
     PathItem,
     Operation,
@@ -182,14 +182,14 @@ def generate_services(paths: Dict[str, PathItem]) -> List[Service]:
             try:
                 compile(sync_so.content, "<string>", "exec")
             except SyntaxError as e:  # pragma: no cover
-                typer.echo(
+                click.echo(
                     f"Error in service {sync_so.operation_id}: {e}"
                 )  # pragma: no cover
 
             try:
                 compile(async_so.content, "<string>", "exec")
             except SyntaxError as e:  # pragma: no cover
-                typer.echo(
+                click.echo(
                     f"Error in service {async_so.operation_id}: {e}"
                 )  # pragma: no cover
 

src/openapi_python_generator/language_converters/python/service_generator.py

@@ -1,8 +1,9 @@
 """Test cases for the __main__ module."""
 import pytest
-from typer.testing import CliRunner
+from click.testing import CliRunner
 
-from openapi_python_generator.__main__ import app
+from openapi_python_generator.__main__ import main
+from tests.conftest import test_data_path, test_result_path
 
 
 @pytest.fixture
@@ -13,4 +14,5 @@ def runner() -> CliRunner:
 
 def test_main_succeeds(runner: CliRunner, model_data_with_cleanup) -> None:
     """It exits with a status code of zero."""
-    runner.invoke(app, ["test_data/test_api.json", "test_result"])
+    result = runner.invoke(main, [str(test_data_path), str(test_result_path)])
+    assert result.exit_code == 0