🦋 ViceroyBot 🦋

A Twitter bot for mimicking writing.

The method for mimicking writing comes from the classic textbook The Practice of Programming and uses a Markov Chain algorithm that the book implements in several different languages.

Now, sure, you can use this without the twitter functionality, but where's the fun in that?

Using this package

First, clone this repository with

git clone https://github.com/frank1010111/viceroybot.git
cd viceroybot
pip install .

Next, you'll need some writings. Sure, you could grab a bunch of tweets, but maybe you'd prefer to improve the discourse of that august site. I recommend grabbing something from Project Gutenberg. Save them in the txt folder.

Then train the Markov chain model with

viceroy train txt/*

If you want to stop here, you can do things like

viceroy generate Little is lacking

But if you want to use twitter, you've got to get set up with authentication. The authentication comes from the Twitter Developer Portal Projects and Apps page.

Copy those into the .env file like so:

export VICEROY_LOCATION=".viceroy"
export BEARER_TOKEN=""
export BEARER_TOKEN_SECRET=""
export ACCESS_TOKEN=""
export ACCESS_TOKEN_SECRET=""

It's great fun. Tweepy gets into the authentication in more detail.

Then you can start building a tweet queue with the command

viceroy queue

By default it will take US trending topics and write a tweet about one. You can send this tweet with

viceroy tweet

And that's how it goes! Happy flying! 🦋