Merge remote-tracking branch 'origin/main' into dev

Author: jeffswartz

.bumpversion.cfg

@@ -0,0 +1,6 @@
+[bumpversion]
+current_version = 3.1.0
+commit = True
+tag = False
+
+[bumpversion:file:opentok/version.py]

.github/workflows/ot.yml

@@ -0,0 +1,26 @@
+name: Opentok Actions
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.5, 3.6, 3.7, 3.8.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r test_requirements.txt
+        pip install -r requirements.txt
+    - name: Test with nosetests
+      run: |
+        nosetests -v tests/test_*

.gitignore

@@ -43,9 +43,13 @@ docs/_build/
 
 # Virtual env
 venv/
+env/
 
 # Mac Desktop files
 .DS_Store
 
 # IDE
 .vscode
+
+#Pypi
+.pypirc

.travis.yml

@@ -16,12 +16,30 @@ this project. If you use this package within your own software as is but don't p
    location on your system, which helps keep you out of dependency hell. You can exit the
    environment using `$ deactivate`.
 
-*  [tox](https://testrun.org/tox/): a testing automation tool that can load many Python versions.
-   This tool allows the project to test against all the compatible versions of Python by leveraging
-   virtualenv and describing the tasks in a metadata file.
+*  [act](https://github.com/nektos/act): a tool for running Github Actions locally. This tool allows
+   developers to easily replicate the same Continuous Integration pipelines we use for code validation.
 
 ## Tasks
 
+## Setup
+
+We currently recommend setting up a development environment using `virtualenv` and installing dependencies
+with `pip`. While the Python Packaging Authority recommends `Pipenv` to manage dependencies, `Pipenv` does
+not install the OpenTok library correctly from source at this time.
+
+We recommend setting up a Python 3.5 or higher `virtualenv` environment. This allows you to isolate dependencies
+for work on the OpenTok library without interfering with any other projects or installations on your system.
+
+    $ virtualenv env
+    $ source env/bin/activate
+    $ pip install -r requirements.txt -r test_requirements.txt
+
+Some IDEs, like Visual Studio Code, will automatically detect the `virtualenv` and use it. 
+
+When you are done, you can leave the `virtualenv` by deactivating it:
+
+    $ deactivate
+
 ### Building
 
 Building isn't necessarily required for a python package, but it is possible. By running the command
@@ -32,10 +50,19 @@ other script in your environment, and continue to update and you make changes.
 
 ### Testing
 
-This project's tests are kicked off by tox. The `tox.ini` file describes the automation. In
-a nutshell, it selects a Python version, installs test dependencies stored in
-`test_requirements.txt`, and then runs `nosetests`. [Nose](https://nose.readthedocs.org) is the
-actual test runner. All of this can be ran using the following command: `$ tox`
+This project's tests are built using the `unittest` [`Nose'](https://nose.readthedocs.org) modules.
+To run the unit tests, install the core as well as development dependencies inside your `virtualenv`:
+
+    $ pip install -r requirements.txt -r test_requirements.txt
+
+You can manually run the test suite for your version of python with:
+
+    $ nosetests
+
+If you would like to run the test suite against a variety of Python versions, we recommend installing
+`act` and running out Github Action "test" workflow:
+
+    $ act --quiet
 
 ### Generating Documentation
 
@@ -45,19 +72,28 @@ actual test runner. All of this can be ran using the following command: `$ tox`
 
 In order to create a release, the following should be completed in order.
 
-1. Ensure all tests are passing (`tox`) and that there is enough test coverage.
+#### Prep the release
+
+1. Ensure all tests are passing (`act`) and that there is enough test coverage.
 1. Make sure you are on the `master` branch of the repository, with all changes merged/committed already.
-1. Update the version number in the source code (`opentok/version.py`) and the README. See [Versioning](#versioning) for
+1. Create a new branch named `release-x.y.z`, with the release version number
+1. Update the version number with `bumpversion`. See [Versioning](#versioning) for
    information about selecting an appropriate version number.
 1. Commit the version number change with the message ("Update to version v.x.x.x"), substituting the new version number.
+1. Create a new pull request with this branch
+
+#### Once PR is merged into `master`
+1. Make sure you are on the `master` branch of the repository
+1. Run `git pull --rebase origin master` to make sure your local code is up-to-date
 1. Create a git tag: `git tag -a vx.y.z -m "Release vx.y.z"`
+1. Run `git push origin vx.y.z` to push the tag to Github
 1. Ensure you have permission to update the `opentok` package on PyPI: <https://pypi.python.org/pypi/opentok>.
-1. Run `python setup.py sdist upload`, which will build and upload the package to PyPI.
-1. Change the version number for future development by adding "a1", then make another commit with the message
-   "Beginning development on next version".
-1. Push the changes to the main repository (`git push origin master`).
-1. Upload the `dist/opentok-x.y.z.tar.gz` file to the
-   [Github Releases](https://github.com/opentok/opentok-python-sdk/releases) page with a description and release notes.
+1. Run the deploy scripts:
+  1. `make clean`
+  1. `make dist`
+  1. `make release`
+1. Create a new release on the [Github Releases](https://github.com/opentok/opentok-python-sdk/releases) page,
+   and attach the files in `dist/` to the release
 
 ## Workflow
 
@@ -73,10 +109,6 @@ from 1.
 ### Branches
 
 *  `master` - the main development branch.
-*  `feat.foo` - feature branches. these are used for longer running tasks that cannot be accomplished in one commit.
-   once merged into master, these branches should be deleted.
-*  `vx.x.x` - if development for a future version/milestone has begun while master is working towards a sooner
-   release, this is the naming scheme for that branch. once merged into master, these branches should be deleted.
 
 ### Tags
 

DEVELOPING.md

@@ -0,0 +1,26 @@
+.PHONY: clean test dist coverage install requirements release release-test
+
+clean:
+	rm -rf dist build
+
+coverage:
+	pytest -v --cov
+	coverage html
+
+test:
+	nosetests -v
+
+dist:
+	python setup.py sdist --formats zip,gztar bdist_wheel
+
+release:
+	twine upload dist/*
+
+install: requirements
+
+requirements: .requirements.txt
+
+.requirements.txt: requirements.txt
+	python -m pip install --upgrade pip setuptools
+	python -m pip install -r requirements.txt
+	python -m pip freeze > .requirements.txt

Makefile

@@ -2,8 +2,6 @@
 OpenTok Python SDK
 ==================
 
-.. image:: https://travis-ci.org/opentok/Opentok-Python-SDK.svg
-   :target: https://travis-ci.org/opentok/Opentok-Python-SDK
 .. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg 
    :target: CODE_OF_CONDUCT.md
 
@@ -25,7 +23,7 @@ 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.10.0
+  opentok>=3.0
 
 Next, install the dependencies::
 
@@ -39,13 +37,13 @@ Initializing
 ~~~~~~~~~~~~
 
 Import the package at the top of any file where you will use it. At the very least you will need the
-``OpenTok`` class. Then initialize an OpenTok instance with your own API Key and API Secret.
+``Client`` class. Then initialize a Client instance with your own API Key and API Secret.
 
 .. code:: python
 
-  from opentok import OpenTok
+  from opentok import Client
 
-  opentok = OpenTok(api_key, api_secret)
+  opentok = Client(api_key, api_secret)
 
 Creating Sessions
 ~~~~~~~~~~~~~~~~~
@@ -238,7 +236,7 @@ For more information on archiving, see the
 Sending Signals
 ~~~~~~~~~~~~~~~~~~~~~
 
-Once a Session is created, you can send signals to everyone in the session or to a specific connection. You can send a signal by calling the ``signal(session_id, payload)`` method of the ``OpenTok`` class. The ``payload`` parameter is a dictionary used to set the ``type``, ``data`` fields. Ỳou can also call the method with the parameter ``connection_id`` to send a signal to a specific connection ``signal(session_id, data, connection_id)``.
+Once a Session is created, you can send signals to everyone in the session or to a specific connection. You can send a signal by calling the ``signal(session_id, payload)`` method of the ``Client`` class. The ``payload`` parameter is a dictionary used to set the ``type``, ``data`` fields. Ỳou can also call the method with the parameter ``connection_id`` to send a signal to a specific connection ``signal(session_id, data, connection_id)``.
 
 .. code:: python
 
@@ -259,7 +257,7 @@ Once a Session is created, you can send signals to everyone in the session or to
 Working with Streams
 ~~~~~~~~~~~~~~~~~~~~~
 
-You can get information about a stream by calling the `get_stream(session_id, stream_id)` method of the `OpenTok` class.
+You can get information about a stream by calling the `get_stream(session_id, stream_id)` method of the `Client` class.
 
 The method returns a Stream object that contains information of an OpenTok stream:
 
@@ -282,7 +280,7 @@ The method returns a Stream object that contains information of an OpenTok strea
   print stream.name #stream name
   print stream.layoutClassList #['full']
 
-Also, you can get information about all the streams in a session by calling the `list_streams(session_id)` method of the `OpenTok` class.
+Also, you can get information about all the streams in a session by calling the `list_streams(session_id)` method of the `Client` class.
 
 The method returns a StreamList object that contains a list of all the streams
 
@@ -300,7 +298,7 @@ The method returns a StreamList object that contains a list of all the streams
   print stream.name #stream name
   print stream.layoutClassList #['full']
 
-You can change the layout classes for streams in a session by calling the `set_stream_class_lists(session_id, stream_list)` method of the `OpenTok` class.
+You can change the layout classes for streams in a session by calling the `set_stream_class_lists(session_id, stream_list)` method of the `Client` class.
 
 The layout classes define how the stream is displayed in the layout of a composed OpenTok archive.
 
@@ -324,7 +322,7 @@ For more information see
 Force Disconnect
 ~~~~~~~~~~~~~~~~~~~~~
 
-Your application server can disconnect a client from an OpenTok session by calling the force_disconnect(session_id, connection_id) method of the OpenTok class, or the force_disconnect(connection_id) method of the Session class.
+Your application server can disconnect a client from an OpenTok session by calling the force_disconnect(session_id, connection_id) method of the Client class, or the force_disconnect(connection_id) method of the Session class.
 
 .. code:: python
 
@@ -472,14 +470,14 @@ For more information about OpenTok live streaming broadcasts, see the
 
 
 Configuring Timeout
--------
-Timeout is passed in the OpenTok constructor:
+-------------------
+Timeout is passed in the Client constructor:
 
 ``self.timeout = timeout``
 
 In order to configure timeout, first create an instance:
 
-``opentok = OpenTok(...., timeout=value)``
+``opentok = Client(...., timeout=value)``
 
 And then proceed to change the value with
 
@@ -504,7 +502,7 @@ Requirements
 
 You need an OpenTok API key and API secret, which you can obtain at https://dashboard.tokbox.com/
 
-The OpenTok Python SDK requires Python 2.6, 2.7, 3.3, 3.4, 3.5 or 3.6
+The OpenTok Python SDK requires Python 3.5 or higher
 
 Release Notes
 -------------
@@ -527,7 +525,11 @@ session uses the OpenTok TURN server to relay audio-video streams.
 
 This version of the SDK includes support for working with OpenTok archives.
 
-The OpenTok.create_session() method now includes a media_mode parameter, instead of a p2p parameter.
+The Client.create_session() method now includes a media_mode parameter, instead of a p2p parameter.
+
+**Changes in v3.X.X:**
+
+This version of the SDK includes significant improvements such as top level entity naming, where the Opentok class is now `Client`.  We also implemented a standardised logging module, improved naming conventions and JWT generation to make developer experience more rewarding.
 
 For details, see the reference documentation at
 http://www.tokbox.com/opentok/libraries/server/python/reference/index.html.

README.rst

@@ -1,4 +1,4 @@
-from .opentok import OpenTok, Roles, MediaModes, ArchiveModes
+from .opentok import OpenTok, Client, Roles, MediaModes, ArchiveModes
 from .session import Session
 from .archives import Archive, ArchiveList, OutputModes
 from .exceptions import (