Update Python Server SDK docs to have a relay mode by default

Author: jeffswartz

docs/README.html

@@ -32,6 +32,9 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
         <li><a href="index.html">OpenTok Python SDK 2.2 2.2.0 documentation</a> &raquo;</li> 
       </ul>
     </div>  
@@ -43,32 +46,27 @@ <h3>Navigation</h3>
 
   <div class="section" id="opentok-python-sdk">
 <h1>OpenTok Python SDK<a class="headerlink" href="#opentok-python-sdk" title="Permalink to this headline">¶</a></h1>
-<a class="reference external image-reference" href="https://travis-ci.org/aoberoi/Opentok-Python-SDK"><img alt="https://travis-ci.org/aoberoi/Opentok-Python-SDK.svg?branch=modernization" src="https://travis-ci.org/aoberoi/Opentok-Python-SDK.svg?branch=modernization" /></a>
+<a class="reference external image-reference" href="https://travis-ci.org/opentok/Opentok-Python-SDK"><img src="https://travis-ci.org/opentok/Opentok-Python-SDK.svg" /></a>
 <p>The OpenTok Python SDK lets you generate
 <a class="reference external" href="http://tokbox.com/opentok/tutorials/create-session/">sessions</a> and
 <a class="reference external" href="http://tokbox.com/opentok/tutorials/create-token/">tokens</a> for <a class="reference external" href="http://www.tokbox.com/">OpenTok</a>
-applications. This version of the SDK also includes support for working with OpenTok 2.0 archives.</p>
-<div class="section" id="installation">
-<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="pip-recommended">
-<h3>Pip (recommended):<a class="headerlink" href="#pip-recommended" title="Permalink to this headline">¶</a></h3>
+applications, and <a class="reference external" href="http://www.tokbox.com/platform/archiving">archive</a> Opentok 2.0 sessions.</p>
+<p>If you are updating from a previous version of this SDK, see
+<a class="reference external" href="#important-changes-in-v22">Important changes in v2.2</a>.</p>
+<div class="section" id="installation-using-pip-recommended">
+<h2>Installation using Pip (recommended):<a class="headerlink" href="#installation-using-pip-recommended" title="Permalink to this headline">¶</a></h2>
 <p>Pip helps manage dependencies for Python projects using the PyPI index. Find more info here:
 <a class="reference external" href="http://www.pip-installer.org/en/latest/">http://www.pip-installer.org/en/latest/</a></p>
 <p>Add the <tt class="docutils literal"><span class="pre">opentok</span></tt> package as a dependency in your project. The most common way is to add it to your
 <tt class="docutils literal"><span class="pre">requirements.txt</span></tt> file:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">opentok</span><span class="o">&gt;=</span><span class="mf">2.2</span>
+<div class="highlight-python"><div class="highlight"><pre>opentok&gt;=2.2.0
 </pre></div>
 </div>
 <p>Next, install the dependencies:</p>
 <div class="highlight-python"><div class="highlight"><pre>$ pip install -r requirements.txt
 </pre></div>
 </div>
 </div>
-<div class="section" id="manually">
-<h3>Manually:<a class="headerlink" href="#manually" title="Permalink to this headline">¶</a></h3>
-<p>Download the latest package zip from the <a class="reference external" href="https://github.com/opentok/Opentok-Python-SDK/releases">Releases page</a></p>
-</div>
-</div>
 <div class="section" id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="initializing">
@@ -85,12 +83,14 @@ <h3>Initializing<a class="headerlink" href="#initializing" title="Permalink to t
 <h3>Creating Sessions<a class="headerlink" href="#creating-sessions" title="Permalink to this headline">¶</a></h3>
 <p>The create an OpenTok Session, use the <tt class="docutils literal"><span class="pre">opentok.create_session()</span></tt> method. There are two optional
 keyword parameters for this method: <tt class="docutils literal"><span class="pre">location</span></tt> which can be set to a string containing an IP
-address, and <tt class="docutils literal"><span class="pre">p2p</span></tt> which is a boolean. This method returns a <tt class="docutils literal"><span class="pre">Session</span></tt> object. Its
-<tt class="docutils literal"><span class="pre">session_id</span></tt> attribute is useful when saving to a persistent store (e.g. database).</p>
-<div class="code python highlight-python"><div class="highlight"><pre><span class="c"># Just a plain Session</span>
+address, and <tt class="docutils literal"><span class="pre">media_mode</span></tt> which is a String (defined by the MediaModes class). This method returns
+a <tt class="docutils literal"><span class="pre">Session</span></tt> object. Its <tt class="docutils literal"><span class="pre">session_id</span></tt> attribute is useful when saving to a persistent store (such
+as a database).</p>
+<div class="code python highlight-python"><div class="highlight"><pre><span class="c"># Just a plain Session:</span>
 <span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">()</span>
-<span class="c"># A p2p Session</span>
-<span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">(</span><span class="n">p2p</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
+<span class="c"># A Session that attempts to send streams directly between clients (falling back</span>
+<span class="c"># to use the OpenTok TURN server to relay streams if the clients cannot connect):</span>
+<span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">(</span><span class="n">media_mode</span><span class="o">=</span><span class="n">MediaModes</span><span class="o">.</span><span class="n">relayed</span><span class="p">)</span>
 <span class="c"># A Session with a location hint</span>
 <span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">(</span><span class="n">location</span><span class="o">=</span><span class="s">u&#39;12.34.56.78&#39;</span><span class="p">)</span>
 
@@ -171,9 +171,18 @@ <h3>Working with Archives<a class="headerlink" href="#working-with-archives" tit
 </div>
 </div>
 </div>
+<div class="section" id="samples">
+<h2>Samples<a class="headerlink" href="#samples" title="Permalink to this headline">¶</a></h2>
+<p>There are two sample applications included in this repository. To get going as fast as possible, clone the whole
+repository and follow the Walkthroughs:</p>
+<ul class="simple">
+<li><a class="reference external" href="sample/HelloWorld/README.md">HelloWorld</a></li>
+<li><a class="reference external" href="sample/Archiving/README.md">Archiving</a></li>
+</ul>
+</div>
 <div class="section" id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
-<p>Reference documentation is available at &lt;<a class="reference external" href="http://www.tokbox.com//opentok/libraries/server/python/reference/index.html">http://www.tokbox.com//opentok/libraries/server/python/reference/index.html</a>&gt; and in the
+<p>Reference documentation is available at &lt;<a class="reference external" href="http://www.tokbox.com/opentok/libraries/server/python/reference/index.html">http://www.tokbox.com/opentok/libraries/server/python/reference/index.html</a>&gt; and in the
 docs directory of the SDK.</p>
 </div>
 <div class="section" id="requirements">
@@ -185,18 +194,19 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
 <h2>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h2>
 <p>See the <a class="reference external" href="https://github.com/opentok/Opentok-Python-SDK/releases">Releases</a> page for details about
 each release.</p>
-<div class="section" id="important-changes-in-v2-0">
-<h3>Important changes in v2.0<a class="headerlink" href="#important-changes-in-v2-0" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id1">
+<h2>Important changes in v2.2<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
 <p>This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
 work with OpenTok 1.0 archives.)</p>
-</div>
+<p>The OpenTok.create_session() method now includes a media_mode parameter, instead of a p2p parameter.</p>
+<p>For details, see the reference documentation at
+&lt;<a class="reference external" href="http://www.tokbox.com/opentok/libraries/server/python/reference/index.html">http://www.tokbox.com/opentok/libraries/server/python/reference/index.html</a>&gt;.</p>
 </div>
 <div class="section" id="development-and-contributing">
 <h2>Development and Contributing<a class="headerlink" href="#development-and-contributing" title="Permalink to this headline">¶</a></h2>
-<p>Interested in contributing? We &lt;3 pull requests! File a new
-<a class="reference external" href="https://github.com/opentok/opentok-python-sdk/issues">Issue</a> or take a look at the existing ones.
-If you are going to send us a pull request, please try to run the test suite first and also include
-tests for your changes.</p>
+<p>Interested in contributing? We :heart: pull requests! See the <a class="reference external" href="DEVELOPING.md">Development</a> and
+<a class="reference external" href="CONTRIBUTING.md">Contribution</a> guidelines.</p>
 </div>
 <div class="section" id="support">
 <h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
@@ -215,24 +225,19 @@ <h2>Support<a class="headerlink" href="#support" title="Permalink to this headli
   <h3><a href="index.html">Table Of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">OpenTok Python SDK</a><ul>
-<li><a class="reference internal" href="#installation">Installation</a><ul>
-<li><a class="reference internal" href="#pip-recommended">Pip (recommended):</a></li>
-<li><a class="reference internal" href="#manually">Manually:</a></li>
-</ul>
-</li>
+<li><a class="reference internal" href="#installation-using-pip-recommended">Installation using Pip (recommended):</a></li>
 <li><a class="reference internal" href="#usage">Usage</a><ul>
 <li><a class="reference internal" href="#initializing">Initializing</a></li>
 <li><a class="reference internal" href="#creating-sessions">Creating Sessions</a></li>
 <li><a class="reference internal" href="#generating-tokens">Generating Tokens</a></li>
 <li><a class="reference internal" href="#working-with-archives">Working with Archives</a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#samples">Samples</a></li>
 <li><a class="reference internal" href="#documentation">Documentation</a></li>
 <li><a class="reference internal" href="#requirements">Requirements</a></li>
-<li><a class="reference internal" href="#release-notes">Release Notes</a><ul>
-<li><a class="reference internal" href="#important-changes-in-v2-0">Important changes in v2.0</a></li>
-</ul>
-</li>
+<li><a class="reference internal" href="#release-notes">Release Notes</a></li>
+<li><a class="reference internal" href="#id1">Important changes in v2.2</a></li>
 <li><a class="reference internal" href="#development-and-contributing">Development and Contributing</a></li>
 <li><a class="reference internal" href="#support">Support</a></li>
 </ul>
@@ -267,6 +272,9 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
         <li><a href="index.html">OpenTok Python SDK 2.2 2.2.0 documentation</a> &raquo;</li> 
       </ul>
     </div>

docs/_sources/README.txt

@@ -2,39 +2,32 @@
 OpenTok Python SDK
 ==================
 
-.. image:: https://travis-ci.org/aoberoi/Opentok-Python-SDK.svg?branch=modernization
-   :target: https://travis-ci.org/aoberoi/Opentok-Python-SDK
+.. image:: https://travis-ci.org/opentok/Opentok-Python-SDK.svg
+   :target: https://travis-ci.org/opentok/Opentok-Python-SDK
 
 The OpenTok Python SDK lets you generate
 `sessions <http://tokbox.com/opentok/tutorials/create-session/>`_ and
 `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.
+applications, and `archive <http://www.tokbox.com/platform/archiving>`_ Opentok 2.0 sessions.
 
+If you are updating from a previous version of this SDK, see
+`Important changes in v2.2 <#important-changes-in-v22>`_.
 
-Installation
-------------
-
-Pip (recommended):
-~~~~~~~~~~~~~~~~~~
+Installation using Pip (recommended):
+-------------------------------------
 
 Pip helps manage dependencies for Python projects using the PyPI index. Find more info here:
 http://www.pip-installer.org/en/latest/
 
 Add the ``opentok`` package as a dependency in your project. The most common way is to add it to your
 ``requirements.txt`` file::
 
-  opentok>=2.2
+  opentok>=2.2.0
 
 Next, install the dependencies::
 
   $ pip install -r requirements.txt
 
-Manually:
-~~~~~~~~~
-
-Download the latest package zip from the `Releases page
-<https://github.com/opentok/Opentok-Python-SDK/releases>`_
-
 
 Usage
 -----
@@ -56,15 +49,17 @@ Creating Sessions
 
 The create an OpenTok Session, use the ``opentok.create_session()`` method. There are two optional
 keyword parameters for this method: ``location`` which can be set to a string containing an IP
-address, and ``p2p`` which is a boolean. This method returns a ``Session`` object. Its
-``session_id`` attribute is useful when saving to a persistent store (e.g. database).
+address, and ``media_mode`` which is a String (defined by the MediaModes class). This method returns
+a ``Session`` object. Its ``session_id`` attribute is useful when saving to a persistent store (such
+as a database).
 
 .. code:: python
 
-  # Just a plain Session
+  # Just a plain Session:
   session = opentok.create_session()
-  # A p2p Session
-  session = opentok.create_session(p2p=True)
+  # A Session that attempts to send streams directly between clients (falling back
+  # to use the OpenTok TURN server to relay streams if the clients cannot connect):
+  session = opentok.create_session(media_mode=MediaModes.relayed)
   # A Session with a location hint
   session = opentok.create_session(location=u'12.34.56.78')
 
@@ -154,10 +149,19 @@ instance of the ``ArchiveList`` class.
   # Get the total number of Archives for this API Key
   total = archive_list.total
 
+Samples
+-------
+
+There are two sample applications included in this repository. To get going as fast as possible, clone the whole
+repository and follow the Walkthroughs:
+
+- `HelloWorld <sample/HelloWorld/README.md>`_
+- `Archiving <sample/Archiving/README.md>`_
+
 Documentation
 -------------
 
-Reference documentation is available at <http://www.tokbox.com//opentok/libraries/server/python/reference/index.html> and in the
+Reference documentation is available at <http://www.tokbox.com/opentok/libraries/server/python/reference/index.html> and in the
 docs directory of the SDK.
 
 Requirements
@@ -173,19 +177,22 @@ Release Notes
 See the `Releases <https://github.com/opentok/Opentok-Python-SDK/releases>`_ page for details about
 each release.
 
-Important changes in v2.0
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Important changes in v2.2
+-------------------------
 
 This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
 work with OpenTok 1.0 archives.)
 
+The OpenTok.create_session() method now includes a media_mode parameter, instead of a p2p parameter.
+
+For details, see the reference documentation at
+<http://www.tokbox.com/opentok/libraries/server/python/reference/index.html>.
+
 Development and Contributing
 ----------------------------
 
-Interested in contributing? We <3 pull requests! File a new
-`Issue <https://github.com/opentok/opentok-python-sdk/issues>`_ or take a look at the existing ones.
-If you are going to send us a pull request, please try to run the test suite first and also include
-tests for your changes.
+Interested in contributing? We :heart: pull requests! See the `Development <DEVELOPING.md>`_ and
+`Contribution <CONTRIBUTING.md>`_ guidelines.
 
 Support
 -------

docs/docs/opentok.html

@@ -124,7 +124,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="class">
 <dt id="opentok.archives.ArchiveList">
-<em class="property">class </em><tt class="descclassname">opentok.archives.</tt><tt class="descname">ArchiveList</tt><big>(</big><em>values</em><big>)</big><a class="headerlink" href="#opentok.archives.ArchiveList" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">opentok.archives.</tt><tt class="descname">ArchiveList</tt><big>(</big><em>sdk</em>, <em>values</em><big>)</big><a class="headerlink" href="#opentok.archives.ArchiveList" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
 <dl class="method">
 <dt id="opentok.archives.ArchiveList.attrs">
@@ -254,15 +254,19 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>mediaMode</strong> (<em>String</em>) &#8211; <p>Determines whether the session will transmit streams using the
-OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default,
-sessions use the OpenTok Media Router.</p>
+OpenTok Media Router (MediaMode.routed) or not (MediaMode.relayed). By default,
+the setting is MediaMode.relayed.</p>
+<p>With the mediaMode property set to MediaMode.relayed, the session
+will attempt to transmit streams directly between clients. If clients cannot connect 
+due to firewall restrictions, the session uses the OpenTok TURN server to relay
+audio-video streams.</p>
 <p>The OpenTok Media Router (see <a class="reference external" href="http://www.tokbox.com/#multiparty">http://www.tokbox.com/#multiparty</a>)
 provides the following benefits:</p>
 <blockquote>
 <div><ul>
 <li><dl class="first docutils">
 <dt>The OpenTok Media Router can decrease bandwidth usage in multiparty sessions.</dt>
-<dd>(When the mediaMode property is set to  MediaMode.RELAYED, each client must send
+<dd>(When the mediaMode property is set to  MediaMode.relayed, each client must send
 a separate audio-video stream to each client subscribing to it.)</dd>
 </dl>
 </li>
@@ -276,10 +280,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 you record, save, and retrieve OpenTok sessions (see <a class="reference external" href="http://tokbox.com/platform/archiving">http://tokbox.com/platform/archiving</a>).</li>
 </ul>
 </div></blockquote>
-<p>With the mediaMode property set to MediaMode.RELAYED, the session
-will attempt to transmit streams directly between clients. If clients cannot connect 
-due to firewall restrictions, the session uses the OpenTok TURN server to relay
-audio-video streams.</p>
 <p>You will be billed for streamed minutes if you use the OpenTok Media Router or if the
 session uses the OpenTok TURN server to relay streams. For information on pricing, see
 the OpenTok pricing page (<a class="reference external" href="http://www.tokbox.com/pricing">http://www.tokbox.com/pricing</a>).</p>