diff options
author | Ib Lundgren <ib.lundgren@gmail.com> | 2013-09-19 15:30:19 +0100 |
---|---|---|
committer | Ib Lundgren <ib.lundgren@gmail.com> | 2013-09-19 15:30:19 +0100 |
commit | 1ebfebaaa68a45e878049d57a0cdc1db4c6c7c13 (patch) | |
tree | f4a0290040fa90d45b84a3dc929e3e62aceb1e98 | |
parent | 4757b62140a0e0aa6f96b6269ade5802442d066a (diff) | |
download | oauthlib-1ebfebaaa68a45e878049d57a0cdc1db4c6c7c13.tar.gz |
Add installation instructions for pypi, github and a few OSs. Fix #77.
-rw-r--r-- | docs/index.rst | 1 | ||||
-rw-r--r-- | docs/installation.rst | 71 | ||||
-rw-r--r-- | docs/oauth2/preconfigured_servers.rst | 2 |
3 files changed, 73 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index c44333a..efd97b2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ For news and discussions please check out our `G+ OAuthLib community`_. .. toctree:: :maxdepth: 1 + installation feature_matrix faq contributing diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..a5be158 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,71 @@ +Installing OAuthLib +=================== + +The recommended way to install OAuthLib is from PyPI but if you are running +into a bug or want to try out recently implemented features you will want to +try the installing directly from the GitHub master branch. + +For various reasons you may wish to install using your OS packaging system and +install instructions for a few are shown below. Please send a PR to add a +missing one. + +Latest release on PYPI +---------------------- + + +.. code-block:: bash + + pip install oauthlib + +Bleeding edge from GitHub master +-------------------------------- + +.. code-block:: bash + + pip install -e git+https://github.com/idan/oauthlib.git#egg=oauthlib + +Debian and derivaties like Ubuntu, Mint, etc. +--------------------------------------------- + +.. code-block:: bash + + apt-get install python-oauthlib + apt-get install python3-oauthlib + +Redhat and Fedora +----------------- + +.. code-block:: bash + + yum install python-oauthlib + yum install python3-oauthlib + +openSUSE +-------- + +.. code-block:: bash + + zypper in python-oauthlib + zypper in python3-oauthlib + +Gentoo +------ + +.. code-block:: bash + + emerge oauthlib + +Arch +---- + +.. code-block:: bash + + pacman -S python-oauthlib + pacman -S python2-oauthlib + +FreeBSD +------- + +.. code-block:: bash + + pkg_add -r security/py-oauthlib/ diff --git a/docs/oauth2/preconfigured_servers.rst b/docs/oauth2/preconfigured_servers.rst index 6513e8d..116f8d4 100644 --- a/docs/oauth2/preconfigured_servers.rst +++ b/docs/oauth2/preconfigured_servers.rst @@ -3,7 +3,7 @@ Preconfigured all-in-one servers A pre configured server is an all-in-one endpoint serving a specific class of application clients. As the individual endpoints, they depend on the use of a -:doc:`validator`. See also :doc:`endpoints`. +:doc:`validator`. Construction is simple, only import your validator and you are good to go:: |