summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHoylen Sue <hoylen@hoylen.com>2017-01-16 10:01:32 +1000
committerHoylen Sue <hoylen@hoylen.com>2017-08-01 22:24:06 +1000
commit9628f3d24a2e9777bccf24115b123eea3e9eb74c (patch)
treec6c4acd22163a2525b2f527d121216172ed2f41f /docs
parent008ebbdebd4c3a0f584ea45007e2581ac71606c2 (diff)
downloadoauthlib-9628f3d24a2e9777bccf24115b123eea3e9eb74c.tar.gz
Documented PyJWT dependency for RSA-SHA1 signatures.
Diffstat (limited to 'docs')
-rw-r--r--docs/oauth1/client.rst15
-rw-r--r--docs/oauth1/server.rst2
2 files changed, 9 insertions, 8 deletions
diff --git a/docs/oauth1/client.rst b/docs/oauth1/client.rst
index a0cfff5..741374e 100644
--- a/docs/oauth1/client.rst
+++ b/docs/oauth1/client.rst
@@ -64,15 +64,16 @@ Using the Client
**RSA Signatures**
- OAuthLib supports the 'RSA-SHA1' signature but does not install the jwt or
- cryptography dependency by default. The cryptography package is much better
- supported on Windows and Mac OS X than PyCrypto, and simpler to install.
- OAuthLib uses the jwt package to smooth out its internal code.
- Users can install cryptography using pip::
+ OAuthLib supports 'RSA-SHA1' signatures, but does not install the
+ PyJWT or cryptography dependencies by default. OAuthLib uses the
+ PyJWT package to smooth out its internal code. The cryptography
+ package is much better supported on Windows and Mac OS X than
+ PyCrypto, and simpler to install. Users can install PyJWT and
+ cryptography using pip::
- pip install jwt cryptography
+ pip install pyjwt cryptography
- When you have cryptography and jwt installed using RSA signatures is
+ When you have cryptography and PyJWT installed, using RSA signatures is
similar to HMAC but differ in a few aspects. RSA signatures does not make
use of client secrets nor resource owner secrets (token secrets) and
requires you to specify the signature type when constructing a client::
diff --git a/docs/oauth1/server.rst b/docs/oauth1/server.rst
index 879b904..f254c91 100644
--- a/docs/oauth1/server.rst
+++ b/docs/oauth1/server.rst
@@ -2,7 +2,7 @@
Creating a Provider
===================
-OAuthLib is a dependency free library that may be used with any web
+OAuthLib is a framework independent library that may be used with any web
framework. That said, there are framework specific helper libraries
to make your life easier.