v0.1.0

Author: softlns

.travis.yml

@@ -0,0 +1,17 @@
+language: python
+python:
+    - "2.7"
+install:
+    - python setup.py install
+before_script:
+    - pip install pytest
+script: py.test
+deploy:
+    provider: pypi
+    user: rejown
+    password:
+        secure: "K6eW3+2aB0vc5BRFw9NmrN7jqTdFID5/AsmXlOfPDfFtdkoRKH4bFZxW22qXQ40Kn5qygWOUlymh1Z1/kb0W0HVInjOIz7NekSyjHlIMLAa9S/bj0ydOoh6wLBBD5SQbtnO7yC2ARtnQ1OEPR2IosqYYNfhXRvnyp0GLHRb14KYQmCnwvAW7JzWPPs8jniJHqir78XmpwhvxD2u3ObjtTpFey6lRzQ1EaWdGWumJmlwooDI+rbJ5DSs/+sPK239ujLHZsiIPZOivlVdwL1S/wErV0TFOZcCNTNJ04dquC7tns8MqxDCz6Rb/9TG4TgevpShp8jTXIaV89dPptDKX3aa9zMXpBf09jiAagjwnvBwbUaNqdUsRCzgw4MFKRzWv1JTqSuHdPM1cU4BRRIVgOvPoLknZJo/thhdtw0Torff63RjVRWAt9bwx0VpMGiovI3ny6cXKSqMmthWOjAWdxcmp0dAXcBH5TP7+LaxDPoPBYwhU2Hd2DP6AZ39yZ9WzApaOvtbIy6wBqvaCDY/sdi6nKjQwMvy/TamKR96/w1BAX6YME3IjKjmZRsiQlEFZckxWQjIqj+/odTHhiqwt3a/7jko5gPVGjPUTA1V2x9W7MEgFyW90JuYud/2BlkKgVyQKjBwRaa99cMLQtmpEmctv1LD/KI0KAKrp3Eql2Xo="
+on:
+    pythoni: 2.7
+    tags: true
+    branch: master

AUTHORS

@@ -0,0 +1,9 @@
+Maintainer:
+
+* Rejown (rejown@gmail.com); 
+
+
+Contributors:
+
+* yimiqisan (yimiqisan@gmail.com);
+* softlns (softliunaisen@gmai.com);

README.md

@@ -1,5 +1,6 @@
 # Flask RESTful Application Code Generator
 
+[![Build Status](https://travis-ci.org/softlns/swagger-py-codegen.svg)](https://travis-ci.org/softlns/swagger-py-codegen)
 
 ## Overview
 
@@ -22,8 +23,64 @@ Create all:
 swagger-py-codegen --swagger-doc api.yml example-app
 ```
 
-## TODO
+Command Options:
 
-- validation support
-- generate client
-- generate tests
+    -s, --swagger, --swagger-doc        Swagger doc file.  [required]
+    -f, --force                         Force overwrite.
+    -p, --package                       Package name / application name.
+    -t, --template-dir                  Path of your custom templates directory.
+    --spec, --specification             Generate online specification json response.
+    --ui                                Generate swagger ui.
+    --help                              Show this message and exit.
+
+## Examples:
+
+Generate example-app from [apis.yml](https://github.com/guokr/swagger-py-codegen/blob/master/api.yml "Title"):  
+
+    $tree
+	.
+	|__ api.yml
+
+    $ swagger_py_codegen -s  api.yml  example-app -p demo
+    $ tree
+	.
+	|__ api.yml
+	|__ example-app
+	   |__ demo
+	   |  |__ __init__.py
+	   |  |__ v1
+	   |     |__ api
+	   |     |  |__ __init__.py
+	   |     |  |__ oauth_auth_approach_approach.py
+	   |     |  |__ oauth_auth_approach.py
+	   |     |  |__ users_token.py
+	   |     |  |__ users_current.py
+	   |     |  |__ users.py
+	   |     |__ __init__.py
+	   |     |__ routes.py
+	   |     |__ schemas.py
+	   |     |__ validators.py
+	   |__ requirements.txt
+	
+Install example-app requirements: 
+
+    $ cd example-app
+    $ pip install -r requirements.txt
+
+Start example-app: 
+
+    $ cd demo
+    $ python __init__.py
+
+And generate example-app-ui from apis.yml with ui:   
+
+    $ swagger_py_codegen -s  api.yml  example-app-ui -p demo-ui --ui
+
+## Authors
+--------
+See the [AUTHORS](https://github.com/guokr/swagger-py-codegen/blob/master/AUTHORS "Title").
+
+
+## License
+--------
+MIT 

tests/swagger_specs/oauth.yml api.ymltests/swagger_specs/oauth.yml renamed to api.yml

@@ -61,6 +61,8 @@ definitions:
             - register
             - open
   Approach:
+    required:
+      - approach
     properties:
       approach:
         type: string
@@ -87,7 +89,7 @@ definitions:
         type: string
 parameters:
   AccessToken:
-    name: access_token
+    name: Authentication
     in: header
     required: true
     type: string

setup.py

@@ -20,10 +20,10 @@
     include_package_data=True,
     entry_points={
         'console_scripts': [
-            'swagger_py_codegen=swagger_py_codegen:codegen'
+            'swagger_py_codegen=swagger_py_codegen:generate'
         ]
     },
-    install_requires=['PyYAML', 'click', 'jinja2'],
+    install_requires=['PyYAML', 'click', 'jinja2', 'dpath'],
     tests_require=['pytest'],
     classifiers=[
         'Development Status :: 3 - Alpha',

swagger_py_codegen/__init__.py

@@ -1,42 +1,3 @@
-# -*- coding: utf-8 -*-
-import codecs
-import click
+from .command import generate
 
-from parser import parse_yaml
-import writer
-
-__version__ = '0.0.9'
-
-
-@click.command()
-@click.argument('path', required=True)
-@click.option('-s', '--swagger-doc', required=True, help='Swagger doc file.')
-@click.option('-f', '--force', is_flag=True, help='Force overwrite.')
-@click.option('-a', '--appname', help='Application name or package name.')
-@click.option('--specification', is_flag=True, help='Generate online specification.')
-@click.option('--ui', is_flag=True, help='Generate swagger ui.')
-def codegen(path, swagger_doc, force=False, appname=None, specification=True, ui=True):
-    if appname is None:
-        appname = path.split('/')[-1].replace('-', '_')
-
-    with codecs.open(swagger_doc, 'r', 'utf-8') as f:
-        m = parse_yaml(f)
-    if not m:
-        print 'swagger-doc could not be read.'
-        exit(-1)
-
-    if specification:
-        import yaml
-        import model
-        res = model.Resource('/_swagger', m)
-        method = model.Method('get', res)
-        with codecs.open(swagger_doc, 'r', 'utf-8') as f:
-            method.response_example = yaml.load(f)
-        res.methods = {'GET': method}
-        m.add_resource(res)
-
-    writer.write(model=m, base_path=path, appname=appname,
-                 overwrite=force, ui=ui)
-
-if __name__ == '__main__':
-    codegen()
+__version__ = '0.1.0'

swagger_py_codegen/__main__.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-import swagger_py_codegen
+from .command import generate
 
-if __name__ == '__main__':
-    swagger_py_codegen.codegen()
+generate()

swagger_py_codegen/base.py

@@ -0,0 +1,67 @@
+import os
+
+from jinja2 import Environment, FileSystemLoader
+
+
+class Code(object):
+
+    template = 'code.tpl'
+    dest_template = '%(package)s/%(basePath)s'
+    override = False
+
+    def __init__(self, data=None, dist_template=None, dist_env=None):
+        self.data = data or {}
+        self.dest_template = dist_template or self.dest_template
+        self.dist_env = dist_env or {}
+
+    def dest(self, env=None):
+        env = env or {}
+        env.update(self.dist_env)
+        return self.dest_template % env
+
+    def before_render(self, jinja_env):
+        pass
+
+
+class CodeGenerator(object):
+
+    dependencies = []
+
+    def __init__(self, swagger):
+        self.swagger = swagger
+
+    def _dependence_callback(self, code):
+        return code
+
+    def _process(self):
+        raise NotImplementedError
+
+    def generate(self):
+        for clz in self.dependencies:
+            dependence = clz(self.swagger)
+            g = dependence.generate()
+            for code in g:
+                yield self._dependence_callback(code)
+
+        for code in self._process():
+            yield code
+
+
+class Template(object):
+
+    def __init__(self):
+        self.loader = FileSystemLoader(os.path.join(
+            os.path.dirname(__file__), 'templates'))
+        self.env = Environment(loader=self.loader)
+
+    def add_searchpath(self, path):
+        self.loader.searchpath.append(path)
+
+    def render(self, template_name, **kwargs):
+        template = self.env.get_template(template_name)
+        return template.render(**kwargs)
+
+    def render_code(self, code):
+        code.before_render(self)
+        return self.render(code.template, **code.data)
+

swagger_py_codegen/command.py

@@ -0,0 +1,110 @@
+import codecs
+try:
+    import simplejson as json
+except ImportError:
+    import json
+from os import makedirs
+from os.path import join, exists, dirname
+
+import yaml
+import click
+
+from .flask import FlaskGenerator
+from .parser import Swagger
+from .base import Template
+
+
+def spec_load(filename):
+    if filename.endswith('.json'):
+        loader = json.load
+    elif filename.endswith('.yml') or filename.endswith('.yaml'):
+        loader = yaml.load
+    else:
+        with codecs.open(filename, 'r', 'utf-8') as f:
+            contents = f.read()
+            contents = contents.strip()
+            if contents[0] in ['{', '[']:
+                loader = json.load
+            else:
+                loader = yaml.load
+    with codecs.open(filename, 'r', 'utf-8') as f:
+        return loader(f)
+
+
+def write(dist, content):
+    dir_ = dirname(dist)
+    if not exists(dir_):
+        makedirs(dir_)
+    with codecs.open(dist, 'w', 'utf-8') as f:
+        f.write(content)
+
+
+def _copy_ui_dir(ui_dest, ui_src):
+    from distutils.dir_util import copy_tree
+    from os import unlink
+
+    if exists(ui_dest):
+        status = 'skip'
+    else:
+        status = 'generate'
+        makedirs(ui_dest)
+        copy_tree(ui_src, ui_dest)
+        unlink(join(ui_dest, 'index.html'))
+    return status
+
+
+@click.command()
+@click.argument('destination', required=True)
+@click.option('-s', '--swagger', '--swagger-doc',
+              required=True, help='Swagger doc file.')
+@click.option('-f', '--force',
+              default=False, is_flag=True, help='Force overwrite.')
+@click.option('-p', '--package',
+              help='Package name / application name.')
+@click.option('-t', '--template-dir',
+              help='Path of your custom templates directory.')
+@click.option('--spec', '--specification',
+              default=False, is_flag=True,
+              help='Generate online specification json response.')
+@click.option('--ui',
+              default=False, is_flag=True,
+              help='Generate swagger ui.')
+def generate(destination, swagger_doc, force=False, package=None,
+             template_dir=None, specification=False, ui=False):
+
+    package = package or destination.replace('-', '_')
+    data = spec_load(swagger_doc)
+    swagger = Swagger(data)
+    generator = FlaskGenerator(swagger)
+    generator.with_spec = specification
+    generator.with_ui = ui
+    template = Template()
+    if template_dir:
+        template.add_searchpath(template_dir)
+    env = dict(package=package,
+               module=swagger.module_name)
+
+    if ui:
+        ui_dest = join(destination, '%(package)s/static/swagger-ui' % env)
+        ui_src = join(dirname(__file__), 'templates/ui')
+        status = _copy_ui_dir(ui_dest, ui_src)
+        click.secho('%-12s%s' % (status, ui_dest))
+
+    for code in generator.generate():
+        source = template.render_code(code)
+        dest = join(destination, code.dest(env))
+        dest_exists = exists(dest)
+        can_override = force or code.override
+        statuses = {
+            (False, False): 'generate',
+            (False, True): 'generate',
+            (True, False): 'skip',
+            (True, True): 'override'
+        }
+        status = statuses[(dest_exists, can_override)]
+        click.secho('%-12s' % status, nl=False)
+        click.secho(dest)
+
+        if status != 'skipped':
+            write(dest, source)
+