Skip to content

Commit a58ee65

Browse files
author
Tom Willis
committed
spelling corrections and linkage
1 parent 71cb478 commit a58ee65

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
# WebobToolkit
22

33
WebobToolKit is a set of utilities that can be used to compose HTTP
4-
clients.
4+
clients built on top of [Webob](http://docs.webob.org/en/latest/reference.html).
55

66
## Getting Started
77

8-
Webob toolkit provides an easy way out of the box to interact with web
9-
sites or wsgi applications. A webob response is returned for every
10-
call so you can leverage your webob knowledge. It may also be useful
11-
for people already familiar with WSGI and WSGI middleware.
8+
WebobToolKit provides an easy way out of the box to interact with web
9+
sites or [wsgi](http://wsgi.readthedocs.org/en/latest/)
10+
applications. A [webob response](http://docs.webob.org/en/latest/reference.html#id2) is
11+
returned for every call so you can leverage your webob knowledge. It
12+
may also be useful for people already familiar with WSGI and [WSGI
13+
middleware](http://docs.webob.org/en/latest/comment-example.html#id5).
1214

1315
### The Client
1416

1517
The WebobToolKit client contains a lot of the typical functionality
1618
you need in an HTTP client. All current HTTP verbs are
1719
supported(GET,POST,PUT,DELETE,OPTIONS,HEAD,...). Each of the methods
18-
takes a url, query string, and an optional assert method and returns a
20+
takes a URL, query string, and an optional assert method and returns a
1921
webob Response object.
2022

21-
#### getting a response from a website
23+
#### Getting a Response from a Website
2224

2325
Here’s an example of how to get a response from wikipedia.org
2426

@@ -34,7 +36,7 @@ print client.get("http://en.wikipedia.org/wiki/HTTP")
3436
#### getting a response from a WSGI application
3537

3638
Most python web frameworks provide a way to expose your web
37-
application as a WSGI app, webobtoolkit can interact with WSGI apps
39+
application as a WSGI app, WebobToolKit can interact with WSGI apps
3840
just as if they were running on a web server. This can provide a way
3941
for you to unit test your application without the web server overhead.
4042

@@ -80,14 +82,14 @@ need to handle like cookies and gzip responses.
8082
#### parameter passing
8183

8284
Often when interacting with websites or wsgi applications you will
83-
need to pass paramters. HTTP provides a couple of ways to do that. One
85+
need to pass parameters. HTTP provides a couple of ways to do that. One
8486
is via query string.
8587

8688

8789
##### query string
8890

8991
The webobtoolkit client can take a query string as either a string or
90-
dictionary like object. Here’s an example of using google’s ajax
92+
dictionary like object. Here’s an example of using Google’s ajax
9193
search api.
9294

9395
```python
@@ -133,7 +135,7 @@ print client.post("http://ajax.googleapis.com/ajax/services/search/web",
133135

134136
##### upload files
135137

136-
WebobToolkit also provides a way to programatically upload files.
138+
WebobToolkit also provides a way to programmaticly upload files.
137139

138140
```python
139141

@@ -161,12 +163,12 @@ print client.post("/", files=dict(file1=("myfile.txt",
161163

162164
#### built-ins
163165

164-
Some of the intracacies of HTTP are handled automatically for you.
166+
Some of the intricacies of HTTP are handled automatically for you.
165167

166168
##### gzipped responses
167169

168170
Some websites return a response that is compressed in order to reduce
169-
bandwidth. By default webobtoolkit can detect and uncompress the
171+
bandwidth. By default WebobToolKit can detect and un-compress the
170172
responses automatically for you
171173

172174
##### cookie support
@@ -181,7 +183,7 @@ response. Here’s an example of how to enable it.
181183

182184

183185
Once enabled, the request and the response will be logged at whichever
184-
log level you specificed.
186+
log level you specified.
185187

186188

187189
```python

0 commit comments

Comments
 (0)