subtle improvements

fix: license mismatch in setup.py

CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.3.2
+- Subtle improvements.
+
 # v0.3.1
 - Packaging fix.
 

docs/source/index.rst

@@ -39,7 +39,7 @@ spread some `Hacktoberfest <https://hacktoberfest.digitalocean.com/>`_ spirit ar
 
 That ``async`` declaration is optional.
 
-This gets you a ASGI app, with a production static files server
+This gets you a ASGI app, with a production static files server (WhiteNoise)
 pre-installed, jinja2 templating (without additional imports), and a
 production webserver based on uvloop, serving up requests with gzip
 compression automatically.

docs/source/tour.rst

@@ -9,7 +9,7 @@ Class-based views (and setting some headers and stuff)::
 
     @api.route("/{greeting}")
     class GreetingResource:
-        def on_request(req, resp, *, greeting):   # or on_get...
+        def on_request(self, req, resp, *, greeting):   # or on_get...
             resp.text = f"{greeting}, world!"
             resp.headers.update({'X-Life': '42'})
             resp.status_code = api.status_codes.HTTP_416

responder/__version__.py

@@ -1 +1 @@
-__version__ = "0.3.1"
+__version__ = "0.3.2"

responder/api.py

@@ -73,11 +73,14 @@ class API:
 
         self.hsts_enabled = enable_hsts
 
+        # Make the static/templates directory if they don't exist.
+        for _dir in (self.static_dir, self.templates_dir):
+            os.makedirs(_dir, exist_ok=True)
+
         self.whitenoise = WhiteNoise(
             application=self._default_wsgi_app, index_file=True
         )
         self.whitenoise.add_files(str(self.static_dir))
-        import apistar
 
         self.whitenoise.add_files(
             (
@@ -90,10 +93,6 @@ class API:
 
         self.formats = get_formats()
 
-        # Make the static/templates directory if they don't exist.
-        for _dir in (self.static_dir, self.templates_dir):
-            os.makedirs(_dir, exist_ok=True)
-
         # Cached requests session.
         self._session = None
         self.background = BackgroundQueue()

setup.py

@@ -145,7 +145,7 @@ setup(
     include_package_data=True,
     license="Apache 2.0",
     classifiers=[
-        "License :: OSI Approved :: MIT License",
+        "License :: OSI Approved :: Apache Software License",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",

static/index.html

@@ -1 +0,0 @@
-lorem

templates/test.html

@@ -1,3 +0,0 @@
-this is a test
-
-{{ api.static_url('test') }}

tests/test_responder.py

@@ -355,6 +355,34 @@ def test_schema_generation():
     assert dump["openapi"] == "3.0"
 
 
+def test_documentation():
+    import responder
+    from marshmallow import Schema, fields
+
+    api = responder.API(title="Web Service", openapi="3.0", docs_route="/docs")
+
+    @api.schema("Pet")
+    class PetSchema(Schema):
+        name = fields.Str()
+
+    @api.route("/")
+    def route(req, resp):
+        """A cute furry animal endpoint.
+        ---
+        get:
+            description: Get a random pet
+            responses:
+                200:
+                    description: A pet to be returned
+                    schema:
+                        $ref = "#/components/schemas/Pet"
+        """
+        resp.media = PetSchema().dump({"name": "little orange"})
+
+    r = api.requests.get("/docs")
+    assert "html" in r.text
+
+
 def test_mount_wsgi_app(api, flask):
     @api.route("/")
     def hello(req, resp):