Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 2.7 KB

README.rst

File metadata and controls

109 lines (68 loc) · 2.7 KB
Raw

Twitchy

Twitchy is an easy to use Twitch API wrapper with focus on the Helix API, webhooks, and chat.

https://user-images.githubusercontent.com/7674344/100273792-5ae52d00-2f2b-11eb-9710-588aeec63a50.png

Requirements

  • Python 3.5 or newer
  • Twitch API Credentials

Installation

pip install twitchy

Usage

from twitchy import Helix

twitch = Helix(client_id="****", oauth_token="****")

me = twitch.get_user()

print(me.id)
print(me.display_name)

Quickstart

Authentication

In January 2020, Twitch made a change that requires all requests to be accompanied by a User Access Token or an App Access Token.

To authenticate as a user, provide the OAuth token when instantiating Helix.

from twitchy import Helix

twitch = Helix(client_id="****", oauth_token="****")

To authenticate using an App Access Token, just provide the Client ID and Client Secret, and Twitchy will handle authorization for you when necessary.

from twitchy import Helix

twitch = Helix(client_id="****", client_secret="****")

To get a Client ID and Client Secret, register an app on the Twitch Dev Console.

Making Requests

Methods on the Helix class will all be named as obviously as possible by naming them after the Twitch Helix endpoint they're interfacing with. You can find examples in our examples folder.

Reference for Twitch Helix endpoints can be found in the Twitch Helix API documentation.

Contributing

Requirements:

  • Commitizen: Commit message consistency.
  • pre-commit: For interfacing with pre-commit git hooks.
  • Black: Code formatting.
  • PyLint: Code linting.

When writing a commit, be sure to use git commit without the -m to open the commitizen cli.

Steps to Contribute:

  • Fork the repo and create your branch from main.
  • If you've added any code that should be tested, add tests.
  • If an issue doesn't exist yet, create an issue for tracking purposes.
  • Open a Pull Request referencing the issue # in the message body.

If contributing user-facing methods, be sure to use the included docstringsTemplate mustache config for docstrings either via editor extension, or manual process.

Reference Links