Merge pull request #8 from studio3104/readme

Update README and add a tiny example

Author: studio3104

README.rst

@@ -18,19 +18,21 @@ A set of py.test fixtures for AWS Chalice
 
 ----
 
-This `pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `cookiecutter-pytest-plugin`_ template.
-
-
 Features
---------
+------------
 
-* TODO
+- Launch the local gateway per test function
+- Provide an abstracted client fixture to access the local gateway
+- Expose an interface to overwrite response context with arbitrary objects
+    - As of Chalice version 1.8.0, LocalGateway object doesn't handle Cognito's context
+    - Not only for this purpose, it's an interface provided to allow custom contexts in unit tests
 
 
 Requirements
 ------------
 
-* TODO
+- `pytest`_
+- `Chalice`_
 
 
 Installation
@@ -44,7 +46,30 @@ You can install "pytest-chalice" via `pip`_ from `PyPI`_::
 Usage
 -----
 
-* TODO
+.. code-block:: python
+
+    from chalice import Chalice
+
+    app = Chalice(__name__)
+
+
+    @app.route('/')
+    def index:
+        return {'hello': 'world'}
+
+
+.. code-block:: python
+
+    from http import HTTPStatus
+
+
+    def test_index(client):
+        response = client.get('/')
+        assert response.status_code == HTTPStatus.OK
+        assert response.json == {'hello': 'world'}
+
+
+See `examples <https://github.com/studio3104/pytest-chalice/tree/master/examples>`_ for more detailed
 
 Contributing
 ------------
@@ -62,7 +87,6 @@ Issues
 
 If you encounter any problems, please `file an issue`_ along with a detailed description.
 
-.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
 .. _`@hackebrot`: https://github.com/hackebrot
 .. _`MIT`: http://opensource.org/licenses/MIT
 .. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
@@ -74,3 +98,4 @@ If you encounter any problems, please `file an issue`_ along with a detailed des
 .. _`tox`: https://tox.readthedocs.io/en/latest/
 .. _`pip`: https://pypi.org/project/pip/
 .. _`PyPI`: https://pypi.org/project
+.. _`Chalice`: https://github.com/aws/chalice

examples/simple/.chalice/config.json

@@ -0,0 +1,9 @@
+{
+  "version": "2.0",
+  "app_name": "simple",
+  "stages": {
+    "dev": {
+      "api_gateway_stage": "api"
+    }
+  }
+}

examples/simple/.gitignore

@@ -0,0 +1,2 @@
+.chalice/deployments/
+.chalice/venv/

examples/simple/app.py

@@ -0,0 +1,10 @@
+from typing import Dict
+
+from chalice import Chalice
+
+app = Chalice(app_name='simple')
+
+
+@app.route('/')
+def index() -> Dict[str, str]:
+    return {'hello': 'world'}

examples/simple/requirements.txt

@@ -0,0 +1 @@
+chalice>=1.8.0

examples/simple/test_requirements.txt

@@ -0,0 +1 @@
+pytest-chalice

examples/simple/tests/__init__.py

@@ -0,0 +1,10 @@
+import pytest
+
+from chalice import Chalice
+
+from app import app as chalice_app
+
+
+@pytest.fixture
+def app() -> Chalice:
+    return chalice_app

examples/simple/tests/conftest.py

@@ -0,0 +1,8 @@
+from http import HTTPStatus
+from pytest_chalice.handlers import RequestHandler
+
+
+def test_index(client: RequestHandler) -> None:
+    response = client.get('/')
+    assert response.status_code == HTTPStatus.OK
+    assert response.json == {'hello': 'world'}