.. jackbox.py readme

jackbox.py

.. image:: https://img.shields.io/github/contributors/ShineyDev/jackbox.py.svg
:target: https://github.com/ShineyDev/jackbox.py/graphs/contributors
:alt: GitHub contributors

.. image:: https://img.shields.io/github/issues/ShineyDev/jackbox.py.svg?colorB=3333ff
:target: https://github.com/ShineyDev/jackbox.py/issues
:alt: Issue count

.. image:: https://readthedocs.org/projects/jackboxpy/badge/?version=latest
:target: https://jackboxpy.readthedocs.io/en/latest/
:alt: Documentation status

.. image:: https://img.shields.io/pypi/status/jackbox.py.svg
:target: https://pypi.python.org/pypi/jackbox.py
:alt: PyPI status information

.. image:: https://img.shields.io/pypi/v/jackbox.py.svg?color=blue
:target: https://pypi.python.org/pypi/jackbox.py
:alt: PyPI version information

.. image:: https://img.shields.io/pypi/pyversions/jackbox.py.svg
:target: https://pypi.python.org/pypi/jackbox.py
:alt: PyPI supported Python versions

.. image:: https://img.shields.io/pypi/l/jackbox.py.svg
:target: https://pypi.python.org/pypi/jackbox.py
:alt: PyPI license information

An asynchronous Python framework for interacting with Jackbox Games services.

This package is not sponsored by or affiliated with Jackbox Games or its affiliates.
"Jackbox Games" and "Jackbox Party Pack" are trademarks or registered trademarks of Jackbox Games, Inc. or its affiliates in the U.S. and elsewhere.

Documentation on how to use this module is available on readthedocs <https://jackboxpy.readthedocs.io/en/latest/>__.

Installation

Python 3.5.2 or higher is required.

To install the latest release from PyPI, use one of the following:

.. code:: sh

# Unix-based systems
python3 -m pip install --upgrade jackbox.py

# Windows
py -3 -m pip install --upgrade jackbox.py

To install the development version from GitHub, use one of the following:

.. code:: sh

# Unix-based systems
python3 -m pip install --upgrade git+https://github.com/ShineyDev/jackbox.py

# Windows
py -3 -m pip install --upgrade git+https://github.com/ShineyDev/jackbox.py