A lightweight python daemon that pushes formatted IRC topic changes from 1+ channels to a central twitter account.
Report Bugs
·
Request Feature
Used by IRC-based video gaming communities to alert their users of chatroom events in real time without needing to continually lurk in the channel(s). Additionally, the twitter feed also functions as an independent log of past topics which can be used for a variety of historical contexts.
In the current usage that was custom made for the independent game streaming community Dopefish_lives on Quakenet, this script extracts the first two elements from a topic string formatted as shown:
Streamer: <item one> | Game: <item two> | Useless information
and tweets it out to the world in the following format:
<item one> is playing <item two> @ Dopelives.com!
If there is demand, this project could be extended to support multiple channels, networks, or other configuration needs so feel free to request a feature!
To get a local copy up and running follow these simple steps.
- Python 3.5+
Note: It's recommended to run the daemon from within a virtual environment.
First install all the requirements using:
pip install -r requirements.txt
Then copy the config.ini.sample to config.ini and edit it to your needs.
Make sure to input all the keys and access tokens supplied by twitter for your app so the bot can post to the service!
Then launch the bot with helpful debug using:
irc3 -v -r config.ini
A Debian-slim based Docker image is also available for easy integration into existing containerized stacks:
docker run -v /path/to/your/edited/config.ini:/app/config.ini coordspace/irctopic2twitter:latest
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Chris Earley - @CoordSpace - [email protected]
Project Link: https://github.com/CoordSpace/IRC-Topic-to-Twitter-Daemon