Metadata-Version: 2.1
Name: Quart-Rapidoc
Version: 0.5.1
Summary: Rapidoc support for openapi sepc
Home-page: https://github.com/marirs/quart-rapidoc
Author: Sriram G
Author-email: marirs@gmail.com
License: MIT
Description: # Rapidoc for Quart
        [![Build Status](https://travis-ci.org/marirs/quart-rapidoc.svg?branch=master)](https://github.com/marirs/quart-rapidoc)
        [![GitHub license](https://img.shields.io/github/license/marirs/quart-rapidoc)](https://github.com/marirs/quart-rapidoc/blob/master/LICENSE)
        
        Create beautiful, customizable, 
        interactive API documentation from OpenAPI Specification for Quart.
        
        ![Rapidoc](docs/screencapture05.png)
        
        [RapiDoc](https://mrin9.github.io/RapiDoc/) is fully customisable and small and fast.
        It comes with built in console to Try out the APIs. 
        Supports authentication mechanism. 
        
        ### Quickstart
        
        First, install ``Quart-Rapidoc``
        
        ```bash
        pip install Quart-Rapidoc
        ```
        
        Next, add Rapidoc class to your code:
        ```python
            from quart import Quart
            from quart_rapidoc import Rapidoc
        
            app = Quart(__name__)
            app.config['DOC_FILE'] = 'petstore.yml'
            Rapidoc(app)
        ```
        
        You can also customise the docs rendering:
        ```python
            from quart import Quart
            from quart_rapidoc import Rapidoc
        
            app = Quart(__name__)
            conf = {
                "allow-try": False,
                "theme": "light",
                "show-header": True,
            }
        
            app.config['RAPIDOC_CONFIG'] = conf            
            Rapidoc(app)
        ```
        More of config parameters can be found [here](https://mrin9.github.io/RapiDoc/api.html#att-general)
        
        ### Compatibility
        
        ``Quart-Rapidoc`` depends on recent versions of Quart, PyYaml. 
        ``Quart-Rapidoc`` may work with older versions, but compatibility fixes for older versions will not be accepted, and 
        future changes may break compatibility in older versions.
        
        Quart-Rapidoc is tested against ``Python 3.7+`` versions.
        
        #### More Info
        Rapidoc: <https://mrin9.github.io/RapiDoc/>
        
        #### Screenshots
        
        ![Rapidoc](docs/screencapture04.png)  
          
          
        ![Rapidoc](docs/screencapture01.png)  
          
          
        ![Rapidoc](docs/screencapture02.png)  
          
          
        ![Rapidoc](docs/screencapture03.png)  
          
          
        ---
        Contributors of Quart-Rapidoc
        
        Sriram G <https://github.com/marirs>
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: tests
Provides-Extra: all
