Rename to flask-apispec.

Author: jmcarp

README.rst

@@ -1,31 +1,31 @@
 ===========
-flask-smore
+flask-apispec
 ===========
 
-.. image:: https://img.shields.io/travis/jmcarp/flask-smore/master.svg
-    :target: https://travis-ci.org/jmcarp/flask-smore
+.. image:: https://img.shields.io/travis/jmcarp/flask-apispec/master.svg
+    :target: https://travis-ci.org/jmcarp/flask-apispec
     :alt: Travis-CI
 
-.. image:: https://img.shields.io/codecov/c/github/jmcarp/flask-smore/master.svg
-    :target: https://codecov.io/github/jmcarp/flask-smore
+.. image:: https://img.shields.io/codecov/c/github/jmcarp/flask-apispec/master.svg
+    :target: https://codecov.io/github/jmcarp/flask-apispec
     :alt: Code coverage
 
-**flask-smore** is a lightweight tool for building REST APIs in Flask. **flask-smore** uses webargs_ for request parsing, marshmallow_ for response formatting, and apispec_ to automatically generate Swagger markup. You can use **flask-smore** with vanilla Flask or a fuller-featured framework like Flask-RESTful_.
+**flask-apispec** is a lightweight tool for building REST APIs in Flask. **flask-apispec** uses webargs_ for request parsing, marshmallow_ for response formatting, and apispec_ to automatically generate Swagger markup. You can use **flask-apispec** with vanilla Flask or a fuller-featured framework like Flask-RESTful_.
 
 Install
 -------
 
 .. code-block::
 
-    pip install flask-smore 
+    pip install flask-apispec 
 
 Quickstart
 ----------
 
 .. code-block:: python
 
     from flask import Flask
-    from flask_smore import use_kwargs, marshal_with
+    from flask_apispec import use_kwargs, marshal_with
 
     from marshmallow import fields, Schema
 
@@ -43,12 +43,12 @@ Quickstart
     def get_pets(**kwargs):
         return Pet.query.filter_by(**kwargs)
 
-**flask-smore** works with function- and class-based views:
+**flask-apispec** works with function- and class-based views:
 
 .. code-block:: python
 
     from flask import make_response
-    from flask_smore.views import MethodResource
+    from flask_apispec.views import MethodResource
 
     class PetResource(MethodResource):
 
@@ -74,12 +74,12 @@ Quickstart
             pet.delete()
             return make_response('', 204)
 
-**flask-smore** generates Swagger markup for your view functions and classes:
+**flask-apispec** generates Swagger markup for your view functions and classes:
 
 .. code-block:: python
 
     from apispec import APISpec
-    from flask_smore.apidoc import Documentation
+    from flask_apispec.apidoc import Documentation
 
     spec = APISpec(
         title='pets',
@@ -96,9 +96,9 @@ Quickstart
 Notes
 -----
 
-**flask-smore** isn't stable yet, and the interface and internals may change. Bug reports and pull requests are much appreciated.
+**flask-apispec** isn't stable yet, and the interface and internals may change. Bug reports and pull requests are much appreciated.
 
-**flask-smore** is strongly inspired by Flask-RESTful_ and Flask-RESTplus_, but attempts to provide similar functionality with greater flexibility and less code.
+**flask-apispec** is strongly inspired by Flask-RESTful_ and Flask-RESTplus_, but attempts to provide similar functionality with greater flexibility and less code.
 
 .. _webargs: https://webargs.readthedocs.org/
 .. _marshmallow: https://marshmallow.readthedocs.org/

examples/petstore.py

@@ -3,8 +3,8 @@
 import six
 import marshmallow as ma
 
-from flask_smore.utils import Ref
-from flask_smore import ResourceMeta, doc, marshal_with, use_kwargs
+from flask_apispec.utils import Ref
+from flask_apispec import ResourceMeta, doc, marshal_with, use_kwargs
 
 class Pet:
     def __init__(self, name, type):
@@ -62,13 +62,13 @@ class PetResource(CrudResource):
 import flask.views
 from apispec import APISpec
 
-from flask_smore.apidoc import Documentation
+from flask_apispec.apidoc import Documentation
 
 app = flask.Flask(__name__)
 spec = APISpec(
     title='title',
     version='v1',
-    plugins=['smore.ext.marshmallow'],
+    plugins=['apispec.ext.marshmallow'],
 )
 docs = Documentation(app, spec)
 

flask_smore/__init__.py renamed to flask_apispec/__init__.py

@@ -13,7 +13,7 @@
 import werkzeug
 from webargs import flaskparser
 
-from flask_smore import utils
+from flask_apispec import utils
 
 def identity(value):
     return value
@@ -42,7 +42,7 @@ def __call__(self, *args, **kwargs):
 
     def call_view(self, *args, **kwargs):
         config = flask.current_app.config
-        parser = config.get('SMORE_WEBARGS_PARSER', flaskparser.parser)
+        parser = config.get('APISPEC_WEBARGS_PARSER', flaskparser.parser)
         annotation = utils.resolve_annotations(self.func, 'args', self.instance)
         if annotation.apply is not False:
             for option in annotation.options:
@@ -53,7 +53,7 @@ def call_view(self, *args, **kwargs):
 
     def marshal_result(self, unpacked, status_code):
         config = flask.current_app.config
-        format_response = config.get('SMORE_FORMAT_RESPONSE', flask.jsonify) or identity
+        format_response = config.get('APISPEC_FORMAT_RESPONSE', flask.jsonify) or identity
         annotation = utils.resolve_annotations(self.func, 'schemas', self.instance)
         schemas = utils.merge_recursive(annotation.options)
         schema = schemas.get(status_code, schemas.get('default'))
@@ -65,18 +65,18 @@ def marshal_result(self, unpacked, status_code):
         return format_output((format_response(output), ) + unpacked[1:])
 
 def activate(func):
-    if isinstance(func, type) or getattr(func, '__smore__', {}).get('wrapped'):
+    if isinstance(func, type) or getattr(func, '__apispec__', {}).get('wrapped'):
         return func
 
     @functools.wraps(func)
     def wrapped(*args, **kwargs):
-        instance = args[0] if func.__smore__.get('ismethod') else None
+        instance = args[0] if func.__apispec__.get('ismethod') else None
         annotation = utils.resolve_annotations(func, 'wrapper', instance)
         wrapper_cls = utils.merge_recursive(annotation.options).get('wrapper', Wrapper)
         wrapper = wrapper_cls(func, instance)
         return wrapper(*args, **kwargs)
 
-    wrapped.__smore__['wrapped'] = True
+    wrapped.__apispec__['wrapped'] = True
     return wrapped
 
 def format_output(values):
@@ -176,17 +176,17 @@ def wrapper(func):
 
 def annotate(func, key, options, **kwargs):
     annotation = utils.Annotation(options, **kwargs)
-    func.__smore__ = func.__dict__.get('__smore__', {})
-    func.__smore__.setdefault(key, []).insert(0, annotation)
+    func.__apispec__ = func.__dict__.get('__apispec__', {})
+    func.__apispec__.setdefault(key, []).insert(0, annotation)
 
 def inherit(child, parents):
-    child.__smore__ = child.__dict__.get('__smore__', {})
+    child.__apispec__ = child.__dict__.get('__apispec__', {})
     for key in ['args', 'schemas', 'docs']:
-        child.__smore__.setdefault(key, []).extend(
+        child.__apispec__.setdefault(key, []).extend(
             annotation
             for parent in parents
-            for annotation in getattr(parent, '__smore__', {}).get(key, [])
-            if annotation not in child.__smore__[key]
+            for annotation in getattr(parent, '__apispec__', {}).get(key, [])
+            if annotation not in child.__apispec__[key]
         )
 
 class ResourceMeta(type):
@@ -208,6 +208,6 @@ def __new__(mcs, name, bases, attrs):
                 inherit(value, parents)
                 setattr(klass, key, activate(value))
                 if not isinstance(value, staticmethod):
-                    value.__dict__.setdefault('__smore__', {})
-                    value.__smore__['ismethod'] = True
+                    value.__dict__.setdefault('__apispec__', {})
+                    value.__apispec__['ismethod'] = True
         return klass

flask_smore/apidoc.py renamed to flask_apispec/apidoc.py

@@ -10,9 +10,9 @@
 from marshmallow import Schema
 from marshmallow.utils import is_instance_or_subclass
 
-from flask_smore import ResourceMeta
-from flask_smore.paths import rule_to_path, rule_to_params
-from flask_smore.utils import resolve_instance, resolve_annotations, merge_recursive
+from flask_apispec import ResourceMeta
+from flask_apispec.paths import rule_to_path, rule_to_params
+from flask_apispec.utils import resolve_instance, resolve_annotations, merge_recursive
 
 class Documentation(object):
     """API documentation collector.

flask_smore/paths.py renamed to flask_apispec/paths.py

@@ -67,8 +67,8 @@ def merge(self, other):
 
 def resolve_annotations(func, key, parent=None):
     annotations = (
-        getattr(func, '__smore__', {}).get(key, []) +
-        getattr(parent, '__smore__', {}).get(key, [])
+        getattr(func, '__apispec__', {}).get(key, []) +
+        getattr(parent, '__apispec__', {}).get(key, [])
     )
     return functools.reduce(
         lambda first, second: first.merge(second),

flask_smore/utils.py renamed to flask_apispec/utils.py

@@ -3,13 +3,13 @@
 import six
 import flask.views
 
-from flask_smore import ResourceMeta
+from flask_apispec import ResourceMeta
 
 class MethodResourceMeta(ResourceMeta, flask.views.MethodViewType):
     pass
 
 class MethodResource(six.with_metaclass(MethodResourceMeta, flask.views.MethodView)):
     """Subclass of `MethodView` that uses the `ResourceMeta` metaclass. Behaves
-    exactly like `MethodView` but inherits **flask-smore** annotations.
+    exactly like `MethodView` but inherits **flask-apispec** annotations.
     """
     methods = None

flask_smore/views.py renamed to flask_apispec/views.py

@@ -1,2 +1,2 @@
 [pytest]
-addopts=--cov flask_smore --cov-report term-missing
+addopts=--cov flask_apispec --cov-report term-missing

pytest.ini

@@ -34,20 +34,20 @@ def read(fname):
     return content
 
 setup(
-    name='flask-smore',
-    version=find_version('flask_smore/__init__.py'),
-    description='Build and document REST APIs with Flask and Smore',
+    name='flask-apispec',
+    version=find_version('flask_apispec/__init__.py'),
+    description='Build and document REST APIs with Flask and apispec',
     long_description=read('README.rst'),
     author='Joshua Carp',
     author_email='[email protected]',
-    url='https://github.com/jmcarp/flask-smore',
+    url='https://github.com/jmcarp/flask-apispec',
     packages=find_packages(exclude=('test*', )),
-    package_dir={'flask_smore': 'flask_smore'},
+    package_dir={'flask_apispec': 'flask_apispec'},
     include_package_data=True,
     install_requires=REQUIRES,
     license=read('LICENSE'),
     zip_safe=False,
-    keywords='flask marshmallow webargs smore',
+    keywords='flask marshmallow webargs apispec',
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',
         'Intended Audience :: Developers',

setup.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-from flask_smore.paths import rule_to_path, rule_to_params
+from flask_apispec.paths import rule_to_path, rule_to_params
 
 def make_rule(app, path, **kwargs):
     @app.route(path, **kwargs)

tests/test_paths.py

@@ -6,10 +6,10 @@
 from marshmallow import fields, Schema
 from flask import make_response
 
-from flask_smore.paths import rule_to_params
-from flask_smore.views import MethodResource
-from flask_smore import doc, use_kwargs, marshal_with
-from flask_smore.apidoc import ViewConverter, ResourceConverter
+from flask_apispec.paths import rule_to_params
+from flask_apispec.views import MethodResource
+from flask_apispec import doc, use_kwargs, marshal_with
+from flask_apispec.apidoc import ViewConverter, ResourceConverter
 
 @pytest.fixture
 def spec():

tests/test_swagger.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-from flask_smore import utils
+from flask_apispec import utils
 
 class TestAnnotations:
 

tests/test_utils.py

@@ -3,9 +3,9 @@
 from flask import make_response
 from marshmallow import fields, Schema
 
-from flask_smore.utils import Ref
-from flask_smore.views import MethodResource
-from flask_smore import doc, use_kwargs, marshal_with
+from flask_apispec.utils import Ref
+from flask_apispec.views import MethodResource
+from flask_apispec import doc, use_kwargs, marshal_with
 
 class TestFunctionViews:
 
@@ -78,13 +78,13 @@ class ChildResource(BaseResource):
             def get(self, **kwargs):
                 return kwargs
 
-        assert not any(MethodResource.__smore__.values())
+        assert not any(MethodResource.__apispec__.values())
 
-        assert BaseResource.__smore__['docs'][0].options[0]['tags'] == ['base']
-        assert ChildResource.__smore__['docs'][0].options[0]['tags'] == ['child']
+        assert BaseResource.__apispec__['docs'][0].options[0]['tags'] == ['base']
+        assert ChildResource.__apispec__['docs'][0].options[0]['tags'] == ['child']
 
-        assert BaseResource.get.__smore__['docs'][0].options[0]['description'] == 'parent'
-        assert ChildResource.get.__smore__['docs'][0].options[0]['description'] == 'child'
+        assert BaseResource.get.__apispec__['docs'][0].options[0]['description'] == 'parent'
+        assert ChildResource.get.__apispec__['docs'][0].options[0]['description'] == 'child'
 
     def test_inheritance_only_http_methods(self, app):
         @use_kwargs({'genre': fields.Str()})