summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIdan Gazit <idan@gazit.me>2012-04-12 17:43:11 +0300
committerIdan Gazit <idan@gazit.me>2012-04-12 17:43:11 +0300
commitd9beec31f4308598c1c79038e842f221e7a80d7b (patch)
tree5cc9a2fa2c458bb2b9af6de83f0f0d636c18c5b4 /docs
parent7987f6de95614fe48090a8030bd63bbf28a7a521 (diff)
downloadoauthlib-d9beec31f4308598c1c79038e842f221e7a80d7b.tar.gz
Rough documentation of Client usage aspects
Diffstat (limited to 'docs')
-rw-r--r--docs/client.rst20
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/client.rst b/docs/client.rst
index 9a9bc23..684d3ab 100644
--- a/docs/client.rst
+++ b/docs/client.rst
@@ -1,3 +1,21 @@
======
Client
-====== \ No newline at end of file
+======
+
+Unicode Everywhere
+------------------
+
+OAuthLib expects you to supply all string-like parameters in unicode. If you're
+using bytestrings in your library, make sure to do a proper conversion to unicode
+before sending the strings to oauthlib.
+
+Request body
+------------
+
+The OAuth 1 spec only covers signing of x-www-url-formencoded information. If
+you are sending some other kind of data in the body (say, multipart file uploads),
+these don't count as a body for the purposes of signing. Don't provide the body
+to Client.sign() if it isn't x-www-url-formencoded data.
+
+For convenience, you can pass body data in two ways: as a dictionary, or as a
+properly-formatted x-www-url-formencoded string.