Metadata-Version: 1.1
Name: zsl-openapi
Version: 0.1.4
Summary: Generate OpenAPI specification out of your ZSL service.
Home-page: https://github.com/AtteqCom/zsl_openapi
Author: Martin Babka
Author-email: babka@atteq.com
License: BSD
Description: ========
        Overview
        ========
        
        
        
        Generate OpenAPI specification for your models and API out of your ZSL service. This module scans the given packages
        for the persistent models and generates model definitions out of them.
        
        The full API (paths) may be declared manually.
        
        * Free software: BSD license
        
        Installation
        ============
        
        ::
        
            pip install zsl-openapi
        
        How to use
        ==========
        
        Define container with the `zsl_openapi.module.OpenAPIModule`.
        
        ::
        
            class MyContainer(WebContainer):
                open_api = OpenAPIModule
        
        Then you may use CLI `open_api` command.
        
        ::
        
            python app.py \
                open_api generate \
                --package storage.models.persistent \
                --output api/openapi_spec_full.yml \
                --description api/openapi_spec.yml
        
        See more in the documentation mentioned below.
        
        Documentation
        =============
        
        https://zsl_openapi.readthedocs.io/
        
        Development
        ===========
        
        Setup a virtualenv using Python 2.7 and activate it. To install all the development requirements run::
        
            pip install -r requirements.txt
        
        To run the all tests run::
        
            tox
        
        Note, to combine the coverage data from all the tox environments run:
        
        .. list-table::
            :widths: 10 90
            :stub-columns: 1
        
            - - Windows
              - ::
        
                    set PYTEST_ADDOPTS=--cov-append
                    tox
        
            - - Other
              - ::
        
                    PYTEST_ADDOPTS=--cov-append tox
        
        
        
        Changelog
        =========
        
        0.1.0 (2017-06-09)
        ------------------
        
        * First release on PyPI.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Utilities
