Skip to content

Commit 3926a94

Browse files
committed
installation section
1 parent fdedb2d commit 3926a94

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.rst

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,35 @@
22
OpenTok Python SDK
33
==================
44

5+
.. image:: https://travis-ci.org/aoberoi/Opentok-Python-SDK.svg?branch=modernization :target: https://travis-ci.org/aoberoi/Opentok-Python-SDK
6+
57
The OpenTok Python SDK lets you generate `sessions <http://tokbox.com/opentok/tutorials/create-session/>`_ and
68
`tokens <http://tokbox.com/opentok/tutorials/create-token/>`_ for `OpenTok <http://www.tokbox.com/>`_ applications. This version of the SDK also includes support for working with OpenTok 2.0 archives.
79

810

9-
## Installation
11+
Installation
12+
------------
13+
14+
Pip (recommended):
15+
~~~~~~~~~~~~~~~~~~
16+
17+
Pip helps manage dependencies for Python projects using the PyPI index. Find more info here:
18+
http://www.pip-installer.org/en/latest/
19+
20+
Add the opentok package as a dependency in your project. The most common way is to add it to your
21+
requirements.txt file::
22+
23+
opentok>=2.2
1024

11-
To install from PyPi using [pip](http://www.pip-installer.org/en/latest/), a package manager for Python.
12-
<pre>
13-
pip install opentok
14-
</pre>
25+
Next, install the dependencies::
1526

16-
If you get "Permission Denied" errors try running it with `sudo` in front:
17-
<pre>
18-
sudo pip install opentok
19-
</pre>
27+
$ pip install -r requirements.txt
2028

21-
You can download the OpenTok Python SDK from GitHub:
29+
Manually:
30+
~~~~~~~~~
2231

23-
<https://github.com/opentok/Opentok-Python-SDK/archive/master.zip>
32+
Download the latest package zip from the `Releases page
33+
<https://github.com/opentok/Opentok-Python-SDK/releases>`_
2434

2535

2636
## Requirements

0 commit comments

Comments
 (0)