Styling fixes, notes in README and 0.6.2 release

Author: rochacbruno

.coveragerc

@@ -1,3 +1,15 @@
 [run]
-include = 
+include =
   flasgger/*.py
+
+[report]
+exclude_lines =
+    pragma: no cover
+    raise NotImplementedError.*
+    raise RuntimeError.*
+    warnings\.warn.*
+    def __repr__
+    def __str__
+    def main()
+    if __name__ == .__main__.:
+    except ImportError.*

README.md

@@ -17,7 +17,10 @@ Flasgger also **provides validation** of the incoming data, using the same speci
 
 Flasgger can work with simple function views or MethodViews using docstring for especification, or using `@swag_from` decorator to get specification from **YAML** or **dict** and also provides **SwaggerView** which can use **Marshmallow Schemas**  as specification.
 
-Flasgger is compatible with `Flask-RESTful` so you can use `Resources` and `swag` specifications together, take a look at [restful example.](examples/restfull.py)
+Flasgger is compatible with `Flask-RESTful` so you can use `Resources` and `swag` specifications together, take a look at [restful example.](examples/restful.py)
+
+Flasgger also supports `Marshmallow APISpec` as base template for specification, if you are using APISPec from Marshmallow take a look at [apispec example.](examples/apispec_example.py)
+
 
 # Installation
 

examples/README.md

@@ -13,6 +13,26 @@ Please contribute adding your example to increase our test coverage
 The only rules to follow is:
 
 - Add extra requirements to `requirements.txt`
-- use `if __name__ == '__main__':` before `app.run()` 
+- use `if __name__ == '__main__':` before `app.run()`
 
+# testing
+
+You can also add extra tests to your example, just create a function called `test_swag` as:
+
+
+```python
+def test_swag(client, specs_data):
+    """
+    This test is runs automatically in Travis CI
+
+    :param client: Flask app test client
+    :param specs_data: {'url': {swag_specs}} for every spec in app
+    """
+    for url, spec in specs_data.items():
+        assert 'Palette' in spec['definitions']
+        assert 'Color' in spec['definitions']
+        # 'route '/colors/<palette>/' becomes '/colors/{palette}/'
+        assert 'colors' in spec['paths']['/colors/{palette}/']['get']['tags']
+
+```
 

examples/apispec_example.py

@@ -1,9 +1,7 @@
 # coding: utf-8
 from flask import Flask, jsonify
-from flasgger import (
-    Swagger, APISpec, Schema, fields
-)
 
+from flasgger import APISpec, Schema, Swagger, fields
 
 # Create an APISpec
 spec = APISpec(
@@ -72,5 +70,3 @@ def random_pet():
 
 if __name__ == '__main__':
     app.run(debug=True)
-
-

examples/base_model_view.py

@@ -1,7 +1,8 @@
 from flask import Flask, jsonify
-from flasgger import Swagger
 from flask.views import MethodView
 
+from flasgger import Swagger
+
 
 class BaseAPIView(MethodView):
     """BAse view"""

examples/colors_from_specdict.py

@@ -3,7 +3,6 @@
 from flasgger import Swagger
 from flasgger.utils import swag_from
 
-
 app = Flask(__name__)
 app.config['SWAGGER'] = {
     'title': 'Colors API',

examples/colors_with_schema.py

@@ -1,6 +1,7 @@
 # coding: utf-8
 from flask import Flask, jsonify
-from flasgger import Swagger, SwaggerView, Schema, fields
+
+from flasgger import Schema, Swagger, SwaggerView, fields
 
 
 class Color(Schema):

examples/compat.py

@@ -7,8 +7,8 @@
 
 
 from flask import Flask, jsonify, request
-from flasgger import Swagger
 
+from flasgger import Swagger
 
 app = Flask(__name__)
 app.config['SWAGGER'] = {

examples/example_blueprint.py

@@ -3,7 +3,6 @@
 from flasgger import Swagger
 from flasgger.utils import swag_from
 
-
 app = Flask(__name__)
 
 example_blueprint = Blueprint("example_blueprint", __name__)

examples/marshmallow_apispec.py

@@ -1,8 +1,8 @@
 # coding: utf-8
 
 from flask import Flask, jsonify, request
-from flasgger import Swagger, SwaggerView, fields, Schema
 
+from flasgger import Schema, Swagger, SwaggerView, fields
 
 app = Flask(__name__)
 app.config['SWAGGER'] = {

examples/no_routes.py

@@ -5,8 +5,8 @@
 """
 from flask import Flask
 from flask.views import MethodView
-from flasgger import Swagger
 
+from flasgger import Swagger
 
 app = Flask(__name__)
 swag = Swagger()

examples/restfull.py examples/restful.py

@@ -3,8 +3,9 @@
 pip install flask-restful
 """
 from flask import Flask
+from flask_restful import Api, Resource, abort, reqparse
+
 from flasgger import Swagger, swag_from
-from flask_restful import reqparse, abort, Api, Resource
 
 app = Flask(__name__)
 api = Api(app)

examples/validation.py

@@ -1,13 +1,6 @@
-from flask import Flask, jsonify, request, Blueprint
-from flasgger import (
-    Schema,
-    Swagger,
-    SwaggerView,
-    fields,
-    swag_from,
-    validate
-)
+from flask import Blueprint, Flask, jsonify, request
 
+from flasgger import Schema, Swagger, SwaggerView, fields, swag_from, validate
 
 app = Flask(__name__)
 Swagger(app)

flasgger/__init__.py

@@ -1,5 +1,5 @@
 
-__version__ = '0.6.1'
+__version__ = '0.6.2'
 __author__ = 'Bruno Rocha'
 __email__ = '[email protected]'
 

flasgger/base.py

@@ -17,10 +17,10 @@
                    render_template, request, url_for)
 from flask.views import MethodView
 from mistune import markdown
+
 from flasgger.constants import OPTIONAL_FIELDS
 from flasgger.marshmallow_apispec import SwaggerView, convert_schemas
 
-
 NO_SANITIZER = lambda text: text  # noqa
 BR_SANITIZER = lambda text: text.replace('\n', '<br/>') if text else text  # noqa
 MK_SANITIZER = lambda text: Markup(markdown(text)) if text else text  # noqa

flasgger/marshmallow_apispec.py

@@ -1,6 +1,8 @@
 # coding: utf-8
 import inspect
+
 from flask.views import MethodView
+
 import flasgger
 
 try:

flasgger/utils.py

@@ -1,17 +1,18 @@
 # coding: utf-8
 
-import os
 import copy
 import inspect
-from functools import wraps
+import os
 from collections import OrderedDict
 from copy import deepcopy
+from functools import wraps
 
 import jsonschema
 import yaml
-from flask import request, abort, Response
+from flask import Response, abort, request
 from jsonschema import ValidationError  # noqa
 from six import string_types
+
 from flasgger.base import _extract_definitions, load_from_file
 
 

tests/conftest.py

@@ -1,9 +1,9 @@
+import json
 import os
-from importlib import import_module
-from flasgger import Swagger
 import random
-import json
+from importlib import import_module
 
+from flasgger import Swagger
 
 EXAMPLES_DIR = "examples/"