sopel-twitter

A Twitter plugin for Sopel.

Getting your API credentials

Twitter's developer application process has become rather tedious and annoying, involving a game of 20 questions with manual verification and sometimes long wait times. Unfortunately you'll need to go through it in order to use this plugin, since the API is needed to retrieve account data and rich link previews.

Once you have a Twitter developer account, you can create an app for your instance of sopel-twitter. You'll need the API Key (consumer_key) and Secret (consumer_secret) for your bot configuration.

Installation

Releases are hosted on PyPI, so after installing Sopel, all you need is pip:

$ pip install sopel-modules.twitter

If you want to use the development version, simply clone the repository and use pip install path/to/sopel-twitter

Configuring

The easiest way to configure sopel-twitter is using Sopel's configuration wizard – simply run sopel-plugins configure twitter and enter the credentials for the Twitter application you created.

Otherwise, you can edit your bot's configuration file:

[twitter]
consumer_key = YOUR_API_KEY_HERE
consumer_secret = YOUR_API_SECRET_HERE
# Optional: For quote-tweets, send a second message showing the quoted tweet?
# Default: True
show_quoted_tweets = True

Usage

Just send a link to a tweet or profile!

You can also retrieve a user's info with the .twitinfo command:

< Wiz> .twitinfo NASA
< Sopel> [Twitter] NASA (@NASA) ✔️ | Pale Blue Dot | http://www.nasa.gov/
         | 204 friends, 46,602,251 followers | 65,377 tweets, 13,040 ♥s
         | Joined: 2007-12-19 - 20:20:32UTC | There's space for everybody. ✨

Changes between 0.3.2 and 0.4.0

Added:

• .twitinfo command for user lookup (#20)
• Support for mobile links (#21)

Changed:

• Updated documentation for configuration (#25) and setup of Twitter API account

Fixed:

• Media link output when quoted tweets are involved (#24)

Changes between 0.3.1 and 0.3.2

Fixed:

• Regression in profile link handling (#16)

Changes between 0.3.0 and 0.3.1

Fixed:

• Stricter /i/ URL matching (#15)

Changes between 0.2.1 and 0.3.0

Changed:

• Tweet output includes a timestamp now (#13)
• Improved media link handling (#5, #12)

Added:

• Handling for profile/user links (#7)
• Handling for less common /i/web/status style links (#11)

Fixed:

• Decode HTML entities before output (#14)

Changes between 0.2.0 and 0.2.1

Fixed:

• Some quoted tweets would cause KeyError: 'text' (#9)

Changes between 0.1.2 and 0.2.0

Changed:

• Now requires Sopel 7.x (#8)
• Newlines in tweet text will be replaced with a carriage return symbol, to indicate author intention (#4)

Added:

• Handling of 280-character tweets (#4)
• More graceful handling of API errors (#6)

Meta:

• Package metadata updated (new maintainer, HTTPS links)

Changes between 0.1.1 and 0.1.2

Added:

• Tweet link handling

Changes between 0.1.0 and 0.1.1

Fixed:

• Unicode on Python 3