Metadata-Version: 2.1
Name: openapi-readme
Version: 0.1.1
Summary: Generate Markdown from an openapi JSON file.
Home-page: https://github.com/seapagan/openapi-readme
License: MIT
Author: Grant Ramsay
Author-email: grant@gnramsay.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Dist: pydantic (>=1.10.2,<2.0.0)
Requires-Dist: typer[all] (>=0.6.1,<0.7.0)
Project-URL: Bug Tracker, https://github.com/seapagan/openapi-readme/issues
Project-URL: Pull Requests, https://github.com/seapagan/openapi-readme/pulls
Project-URL: Repository, https://github.com/seapagan/openapi-readme
Description-Content-Type: text/markdown

# OpenAPI Readme Generator

Generates Markdown suitable for a README file from a local `openapi.json` file.

## Usage

Run this in the same directory as your `openapi.json` file. By default the
Markdown output will be printed to the console, but you can redirect it out to
a file too.

The particular styling of the generated Markdown is currently hardcoded, though
plans are afoot to implement some sort of themeing.

## Options

### --help

Show application usage hints and help.

### --route-level

Specify the heading level for each Route in the generated documentation. This
defaults to **4** if not specified, ie:

```Markdown
#### **`GET`** _/user/list_
```

### --inject

Injects the new Markdown directly into a `README.md` file in the current
directory, if it is found.
You need to add the placeholder comment `<!--
openapi-schema -->` to your markdown where you want it to be injected:

```Markdown
This is some preceeding text

### API Schema description
<!-- openapi-schema -->

### Next section
The document continues unaffected after the injection.
```

<!-- openapi-schema -->

