Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshuaskelly/twitch-observer
Turn Twitch chatter into Python events
https://github.com/joshuaskelly/twitch-observer
python twitch twitch-bot
Last synced: 26 days ago
JSON representation
Turn Twitch chatter into Python events
- Host: GitHub
- URL: https://github.com/joshuaskelly/twitch-observer
- Owner: joshuaskelly
- License: mit
- Created: 2017-06-16T21:03:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-11T18:21:42.000Z (over 6 years ago)
- Last Synced: 2024-10-08T17:53:10.198Z (2 months ago)
- Topics: python, twitch, twitch-bot
- Language: Python
- Homepage:
- Size: 434 KB
- Stars: 26
- Watchers: 4
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-twitch-dev - joshuaskelly/twitch-observer - Turn Twitch chatter into Python events. (Libraries / Python)
README
# [](https://github.com/JoshuaSkelly/twitch-observer)
> Turn Twitch chatter into Python events.
# twitch-observer
[](./LICENSE) [](https://www.python.org/) [](https://www.python.org/) [](https://pypi.python.org/pypi/twitchobserver) [](https://travis-ci.org/joshuaskelly/twitch-observer) [](http://twitch-observer.readthedocs.io/en/latest)
twitchobserver makes interacting with Twitch chat super easy. It is built and tuned for realtime applications. You can make chatbots chat. You can build *Twitch Plays* video games.
## Features
- *Pure Python:* No extra dependencies. Just plain and simple Python.
- *Small API:* With a few classes and a handful of methods, you can learn it over a coffee break.
- *Event Based:* Makes writing apps easy and straightforward.
- *Context Manager:* Further simplifies working with observers.
## Installation
```$ pip install twitchobserver```
## Usage
```python
from twitchobserver import Observer
observer = Observer('Nick', 'oauth:abcdefghijklmnopqrstuvwxyz0123')
observer.start()
observer.join_channel('channel')
observer.send_message('Hello and goodbye', 'channel')
observer.leave_channel('channel')
```
## Documentation
API documentation can be found over on [ReadtheDocs.org](http://twitch-observer.readthedocs.io/en/latest).
## Tests
```$ python -m unittest discover -s tests```
## Examples
#### Echo bot
Whenever a message is sent, echo it back. The ```Observer``` is created as a [context manager object](https://docs.python.org/3/reference/datamodel.html#context-managers) which will implicitly handle calling ```start()``` and ```stop()```.
```python
import time
from twitchobserver import Observer
with Observer('Nick', 'oauth:abcdefghijklmnopqrstuvwxyz0123') as observer:
observer.join_channel('channel')
while True:
try:
for event in observer.get_events():
if event.type == 'TWITCHCHATMESSAGE':
observer.send_message(event.message, event.channel)
time.sleep(1)
except KeyboardInterrupt:
observer.leave_channel('channel')
break
```
More examples can be found in the [Cookbook](https://github.com/JoshuaSkelly/twitch-observer/wiki/Cookbook).
## Contributors
[](http://github.com/joshuaskelly) | [](https://github.com/pythooonuser) | [](https://github.com/Senpos)
---|---|---
[Joshua Skelton](http://github.com/joshuaskelly) | [Felix Siebeneicker](https://github.com/pythooonuser) | [Kovalchuk Evgeny](https://github.com/Senpos)
## Changelog
For a detailed history of changes made to the twitchobserver see the [changelog](./CHANGELOG.md).
## License
MIT
See the [license](./LICENSE) document for the full text.