Skip to content

Commit e751aa0

Browse files
committed
Update README
1 parent 7c54e88 commit e751aa0

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,21 @@ A set of py.test fixtures for AWS Chalice
1818

1919
----
2020

21-
This `pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `cookiecutter-pytest-plugin`_ template.
22-
23-
2421
Features
25-
--------
22+
------------
2623

27-
* TODO
24+
- Launch the local gateway per test function
25+
- Provide an abstracted client fixture to access the local gateway
26+
- Expose an interface to overwrite response context with arbitrary objects
27+
- As of Chalice version 1.8.0, `LocalGateway` object doesn't handle Cognito's context
28+
- Not only for this purpose, it's an interface provided to allow custom contexts in unit tests
2829

2930

3031
Requirements
3132
------------
3233

33-
* TODO
34+
- `pytest`_
35+
- `Chalice`_
3436

3537

3638
Installation
@@ -44,7 +46,11 @@ You can install "pytest-chalice" via `pip`_ from `PyPI`_::
4446
Usage
4547
-----
4648

47-
* TODO
49+
.. literalinclude:: examples/simple/app.py
50+
51+
.. literalinclude:: examples/simple/tests/test_app.py
52+
53+
See `examples <https://github.com/studio3104/pytest-chalice/tree/master/examples>`_ for more detailed
4854

4955
Contributing
5056
------------
@@ -62,7 +68,6 @@ Issues
6268

6369
If you encounter any problems, please `file an issue`_ along with a detailed description.
6470

65-
.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
6671
.. _`@hackebrot`: https://github.com/hackebrot
6772
.. _`MIT`: http://opensource.org/licenses/MIT
6873
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
@@ -74,3 +79,4 @@ If you encounter any problems, please `file an issue`_ along with a detailed des
7479
.. _`tox`: https://tox.readthedocs.io/en/latest/
7580
.. _`pip`: https://pypi.org/project/pip/
7681
.. _`PyPI`: https://pypi.org/project
82+
.. _`Chalice`: https://github.com/aws/chalice

0 commit comments

Comments
 (0)