Merge pull request #154 from opentok/dev

Compliance with Vonage repo standards and More - Dev to Master

Author: superdiana

.github/workflows/main.yml renamed to .github/workflows/metrics.yml

@@ -8,7 +8,7 @@ jobs:
   recordMetrics:
     runs-on: ubuntu-latest
     steps:
-    - uses: michaeljolley/aggregit@v1.3
+    - uses: michaeljolley/aggregit@v1
       with:
         githubToken: ${{ secrets.GITHUB_TOKEN }}
         project_id: ${{ secrets.project_id }}

.gitignore

@@ -45,4 +45,7 @@ docs/_build/
 venv/
 
 # Mac Desktop files
-.DS_Store
+.DS_Store
+
+# IDE
+.vscode

.travis.yml

@@ -1,11 +1,9 @@
 language: python
 python:
-- '2.6'
 - '2.7'
-- '3.3'
-- '3.4'
 - '3.5'
 - '3.6'
+- '3.7'
 install:
 - pip install -r test_requirements.txt
 - pip install -r requirements.txt

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing Guidelines
 
-For anyone looking to get involved to this project, we are glad to hear from you. Here are a few types of contributions
+For anyone looking to get involved in this project, we are glad to hear from you. Here are a few types of contributions
 that we would be interested in hearing about.
 
 *  Bug fixes
@@ -12,14 +12,12 @@ that we would be interested in hearing about.
     -  If you'd like to accomplish something in the library that it doesn't already do, describe the problem in a new
        Github Issue.
     -  Issues that have been identified as a feature request will be labelled `enhancement`.
-    -  If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending
-       too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at
-       the time.
+    -  If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at the time.
 *  Tests, Documentation, Miscellaneous
     -  If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative
-       implementation of something that may have more advantages, or any other change we would still be glad hear about
+       implementation of something that may have more advantages or any other change we would still be glad to hear about
        it.
-       -  If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
+       -  If it's a trivial change, go ahead and send a Pull Request with the changes you have in mind
        -  If not, open a Github Issue to discuss the idea first.
 
 ## Requirements
@@ -37,7 +35,7 @@ continue to add more commits to the branch you have sent the Pull Request from.
 
 1. Fork this repository on GitHub.
 1. Clone/fetch your fork to your local development machine.
-1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out.
+1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc.) and check it out.
 1. Make your changes and commit them. (Did the tests pass?)
 1. Push your new branch to your fork. (e.g. `git push myname issue-12`)
 1. Open a Pull Request from your new branch to the original fork's `master` branch.

README.rst

@@ -4,6 +4,12 @@ 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
+
+.. image:: https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg
+   :height: 48px
+   :alt: Tokbox is now known as Vonage
 
 The OpenTok Python SDK lets you generate
 `sessions <http://tokbox.com/opentok/tutorials/create-session/>`_ and
@@ -464,6 +470,21 @@ You can dynamically change the layout type of a live streaming broadcast.
 For more information about OpenTok live streaming broadcasts, see the
 `Broadcast developer guide <https://tokbox.com/developer/guides/broadcast/>`_.
 
+
+Configuring Timeout
+-------
+Timeout is passed in the OpenTok constructor:
+
+``self.timeout = timeout``
+
+In order to configure timeout, first create an instance:
+
+``opentok = OpenTok(...., timeout=value)``
+
+And then proceed to change the value with
+
+``opentok.timeout = value``
+
 Samples
 -------
 
@@ -476,7 +497,7 @@ repository and follow the Walkthroughs:
 Documentation
 -------------
 
-Reference documentation is available at <http://www.tokbox.com/opentok/libraries/server/python/reference/index.html>.
+Reference documentation is available at http://www.tokbox.com/opentok/libraries/server/python/reference/index.html.
 
 Requirements
 ------------
@@ -509,18 +530,20 @@ 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.
 
 For details, see the reference documentation at
-<http://www.tokbox.com/opentok/libraries/server/python/reference/index.html>.
+http://www.tokbox.com/opentok/libraries/server/python/reference/index.html.
 
 Development and Contributing
 ----------------------------
 
 Interested in contributing? We :heart: pull requests! See the `Development <DEVELOPING.md>`_ and
 `Contribution <CONTRIBUTING.md>`_ guidelines.
 
-Support
--------
+Getting Help
+------------
 
-See https://support.tokbox.com/ for all our support options.
+We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:
 
-Find a bug? File it on the `Issues <https://github.com/opentok/opentok-python-sdk/issues>`_ page.
-Hint: test cases are really helpful!
+* Open an issue on this repository
+* See https://support.tokbox.com/ for support options
+* Tweet at us! We're `@VonageDev on Twitter <https://twitter.com/VonageDev>`_
+* Or `join the Vonage Developer Community Slack <https://developer.nexmo.com/community/slack>`_

dev_requirements.txt

@@ -0,0 +1,2 @@
+black
+pylint