feat: add CLI

Author: sh1nj1

README.md

@@ -2,26 +2,29 @@
 
 This is a Python script that generates API documentation from an OpenAPI specification file.
 
-## Requirements
+## Usage
 
-- Python 3.x
-- json
-- PyYAML
-- openapi-core
-- Jinja2
+`pip install openapi-markdown`
 
-## Development
+### CLI
 
-`pip install -r requirement.txt`
+You can use `openapi2markdown` command as follows:
 
-install a project in editble mode
-`pip install -e ./`
+```
+% openapi2markdown --help
+Usage: openapi2markdown [OPTIONS] INPUT_FILE [OUTPUT_FILE]
 
-run tests
+  Convert OpenAPI spec to Markdown documentation.
 
-`python -m unittest`
+  INPUT_FILE: Path to OpenAPI specification file (JSON or YAML) OUTPUT_FILE:
+  Path where markdown file will be generated (optional, defaults to INPUT_FILE
+  with .md extension)
 
-## Usage
+Options:
+  -t, --templates-dir DIRECTORY  Custom templates directory path
+```
+
+### Library
 
 ```python
 from openapi_markdown.generator import to_markdown
@@ -35,8 +38,26 @@ to_markdown(apiFile, outputFile)
 - If you want to use your own template, creates 'templates' directory and put [`api_doc_template.md.j2`](src/openapi_markdown/templates/api_doc_template.md.j2) file in it.
 - You can change templates directory by passing it as the 3rd argument of `to_markdown`.
 
+## Development
+
+### Requirements
+
+- Python 3.x
+- json
+- PyYAML
+- openapi-core
+- Jinja2
+
+`pip install -r requirement.txt`
+
+install a project in editble mode
+`pip install -e ./`
+
+run tests
+
+`python -m unittest`
 
-## Deploy
+### Deploy
 
 ```
 python3 -m pip install --upgrade twine

pyproject.toml

@@ -26,3 +26,6 @@ files = ["requirements.txt"]
 [project.urls]
 "Homepage" = "https://github.com/vrerv/openapi-markdown"
 "Bug Tracker" = "https://github.com/vrerv/openapi-markdown/issues"
+
+[project.scripts]
+openapi2markdown = "openapi_markdown.bin.cli:main"

requirements.txt

@@ -1,3 +1,4 @@
 PyYAML==6.0.2
 openapi-core==0.19.*
-Jinja2==3.1.4
+Jinja2==3.1.*
+click==8.1.*

src/openapi_markdown/bin/__init__.py

@@ -0,0 +1 @@
+# Empty file is fine, just needs to exist

src/openapi_markdown/bin/cli.py

@@ -0,0 +1,33 @@
+#! /usr/bin/env python
+
+import click
+from openapi_markdown.generator import to_markdown
+import os
+
+@click.command()
+@click.argument('input_file', type=click.Path(exists=True))
+@click.argument('output_file', type=click.Path(), required=False)
+@click.option('--templates-dir', '-t',
+              type=click.Path(exists=True, file_okay=False, dir_okay=True),
+              help='Custom templates directory path')
+def main(input_file, output_file, templates_dir):
+    """Convert OpenAPI spec to Markdown documentation.
+
+    INPUT_FILE: Path to OpenAPI specification file (JSON or YAML)
+    OUTPUT_FILE: Path where markdown file will be generated (optional, defaults to INPUT_FILE with .md extension)
+    """
+    if output_file is None:
+        output_file = os.path.splitext(input_file)[0] + '.md'
+        
+    try:
+        # Use default templates if templates_dir is not provided
+        if templates_dir is None:
+            to_markdown(input_file, output_file)
+        else:
+            to_markdown(input_file, output_file, templates_dir)
+        click.echo(f"Successfully generated markdown documentation at {output_file}")
+    except Exception as e:
+        raise e
+
+if __name__ == '__main__':
+    main()