Update README to be useful

Closes #1

Author: dbanty

README.md

@@ -1,22 +1,49 @@
 # openapi-python-client
-
-## Purpose
 Generate modern Python clients from OpenAPI
 
-## Release Process
-1. Start a release with Git Flow
-1. Update the version number in `pyproject.toml` with `poetry version <rule>`
-1. Ensure all requirements are pointing to released versions
-1. Add the release date to the new version in [CHANGELOG.md]
-1. Commit and push any changes
-1. Create a pull request from the release branch to master
-1. Get approval from all stakeholders
-1. Ensure all checks pass (e.g. CircleCI)
-1. Open and merge the pull request
-1. Create a tag on the merge commit with the release number
+**This project is still in early development and does not support all OpenAPI features**
+
+## Why This?
+The Python clients generated by openapi-generator support Python 2 and therefore come with a lot of baggage. This tool 
+aims to generate clients which:
+1. Use all the latest and greatest Python features like type annotations and dataclasses
+1. Don't carry around a bunch of compatibility code for older version of Python (e.g. the `six` package)
+1. Have better documentation and more obvious usage instructions
+
+Additionally, because this generator is written in Python, it should be more accessible to contribution by the people 
+using it (Python developers).
+
+## Installation
+`pip install openapi-python-client`
+
+## Usage
+`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.
+
+## 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
+1. A Python module named just like the auto-generated project name (e.g. "my_api_client") which contains:
+    1. A `client` module which will have both a `Client` class and an `AuthenticatedClient` class.  You'll need these 
+    for calling the functions in the `api` module.
+    1. An `api` module which will contain one module for each tag in your OpenAPI spec, as well as a `default` module 
+    for endpoints without a tag.  Each of these modules in turn contains one function for calling each endpoint.
+    1. A `models` module which has all the classes defined by the various schemas in your OpenAPI spec
+    
+## OpenAPI features supported
+1. All HTTP Methods
+1. JSON and form bodies, path and query parameters
+1. float, string, int, datetimes, string enums, and custom schemas or lists containing any of those
+1. html/text or application/json responses containing any of the previous types
+1. Bearer token security
+
 
 ## Contributors 
  - Dylan Anthony <[email protected]> (Owner)
 
 
 [CHANGELOG.md]: CHANGELOG.md
+[Poetry]: https://python-poetry.org/

openapi_python_client/__init__.py

@@ -1,18 +1,16 @@
 """ Generate modern Python clients from OpenAPI """
-import sys
 from pathlib import Path
 from typing import Any, Dict
 
 import orjson
 import requests
 from jinja2 import Environment, PackageLoader
 
-from .models import OpenAPI, import_string_from_reference
+from .openapi_parser import OpenAPI, import_string_from_reference
 
 
-def main() -> None:
+def main(url: str) -> None:
     """ Generate the client library """
-    url = sys.argv[1]
     json = _get_json(url)
     data_dict = _parse_json(json)
     openapi = OpenAPI.from_dict(data_dict)
@@ -33,6 +31,7 @@ def _build_project(openapi: OpenAPI) -> None:
 
     # Create output directories
     project_name = f"{openapi.title.replace(' ', '-').lower()}-client"
+    print(f"Generating {project_name}")
     package_name = f"{openapi.title.replace(' ', '_').lower()}_client"
     project_dir = Path.cwd() / project_name
     project_dir.mkdir()

openapi_python_client/__main__.py

@@ -1,3 +1,3 @@
-from . import main
+from .cli import cli
 
-main()
+cli()

openapi_python_client/cli.py

@@ -0,0 +1,16 @@
+import click
+
+from . import main
+
+
+@click.group()
+def cli():
+    """ Entrypoint into CLI """
+    pass
+
+
+@cli.command()
+@click.option("--url", required=True, help="The URL to the openapi.json file")
+def generate(url: str):
+    """ Generate a new OpenAPI Client library """
+    main(url=url)

openapi_python_client/models/__init__.py renamed to openapi_python_client/openapi_parser/__init__.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openapi-python-client"
-version = "0.1.0"
+version = "0.1.0-dev.0"
 description = "Generate modern Python clients from OpenAPI"
 
 authors = [
@@ -20,6 +20,10 @@ requests = "^2.22.0"
 orjson = "^2.4.0"
 jinja2 = "^2.11.1"
 stringcase = "^1.2.0"
+click = "^7.0"
+
+[tool.poetry.scripts]
+openapi-python-client = "openapi_python_client.cli:cli"
 
 [tool.poetry.dev-dependencies]
 pytest = "*"