Skip to content

Commit

Permalink
Merge pull request #61 from deejay1/readme_lang
Browse files Browse the repository at this point in the history
Fixup language a little
  • Loading branch information
pnuckowski committed May 4, 2017
2 parents 5028fb2 + 52f0ffb commit 6ec5c75
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ aioresponses
:alt: Documentation Status


Aioresponses is a helper for mock/fake web requests in python aiohttp package.
Aioresponses is a helper to mock/fake web requests in python aiohttp package.

For *requests* module there is a lot of packages that helps us with testing (eg. *httpretty*, *responses*, *requests-mock*).
For *requests* module there are a lot of packages that help us with testing (eg. *httpretty*, *responses*, *requests-mock*).

When it comes to testing asynchronous http requests it is a bit harder (at least at the beginning).
The purpose of this package is to provide an easy way to test asynchronous http requests.
When it comes to testing asynchronous HTTP requests it is a bit harder (at least at the beginning).
The purpose of this package is to provide an easy way to test asynchronous HTTP requests.

Installing
----------
Expand All @@ -41,11 +41,11 @@ Installing
Usage
--------

To mock out http request use *aioresponses* as method decorator or as context manager.
To mock out HTTP request use *aioresponses* as a method decorator or as a context manager.

Response *status* code, *body*, *payload* (for json response) and *headers* can be mocked.

Supported http methods: **get**, **post**, **put**, **patch**, **delete** and **options**.
Supported HTTP methods: **GET**, **POST**, **PUT**, **PATCH**, **DELETE** and **OPTIONS**.

.. code:: python
Expand All @@ -65,7 +65,7 @@ Supported http methods: **get**, **post**, **put**, **patch**, **delete** and **
for convenience use *payload* argument to mock out json response. Example below.

**as context manager**
**as a context manager**

.. code:: python
Expand All @@ -84,7 +84,7 @@ for convenience use *payload* argument to mock out json response. Example below.
assert dict(foo='bar') == data
**aioresponses allow to mock out any HTTP headers**
**aioresponses allows to mock out any HTTP headers**

.. code:: python
Expand All @@ -108,7 +108,7 @@ for convenience use *payload* argument to mock out json response. Example below.
# under the neath `multidict` is used to work with HTTP headers
assert resp.headers['Connection'] == 'keep-alive'
**allow to register different response for the same url**
**allows to register different responses for the same url**

.. code:: python
Expand All @@ -130,7 +130,7 @@ for convenience use *payload* argument to mock out json response. Example below.
assert resp2.status == 200
**allow to passthrough to a specified list of servers**
**allows to passthrough to a specified list of servers**

.. code:: python
Expand All @@ -145,7 +145,7 @@ for convenience use *payload* argument to mock out json response. Example below.
resp = loop.run_until_complete(session.get('http://backend/api'))
**aioresponses allow to throw an exception**
**aioresponses allows to throw an exception**

.. code:: python
Expand All @@ -167,7 +167,7 @@ for convenience use *payload* argument to mock out json response. Example below.
Features
--------
* Easy to mock out http requests made by *aiohttp.ClientSession*
* Easy to mock out HTTP requests made by *aiohttp.ClientSession*

Disclaimer
----------
Expand All @@ -179,7 +179,7 @@ License
* Free software: MIT license

Credits
---------
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

Expand Down

0 comments on commit 6ec5c75

Please sign in to comment.