Skip to content

Commit

Permalink
Added documentation and removed unneeded line.
Browse files Browse the repository at this point in the history
  • Loading branch information
kyranb committed Jul 6, 2015
1 parent 6f204f1 commit 65dc75c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,19 @@ By default, the bot looks up the 100 most recent tweets. You can change this num
my_bot = TwitterBot()
my_bot.auto_unfollow_nonfollowers()

If there are certain users that you would like to not unfollow, add their user id to the USERS_KEEP_FOLLOWING list.

You will need to manually edit the code if you want to add special users that you will keep following even if they don't follow you back.

####Automatically unfollow all users.

from TwitterFollowBot import TwitterBot

my_bot = TwitterBot()
my_bot.auto_unfollow_all_followers()



####Automatically mute all users that you have followed

from TwitterFollowBot import TwitterBot
Expand Down
3 changes: 1 addition & 2 deletions TwitterFollowBot/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -404,10 +404,9 @@ def auto_unfollow_nonfollowers(self,count=None):
self.TWITTER_CONNECTION.friendships.destroy(user_id=user_id)
print("Unfollowed %d" % (user_id), file=sys.stdout)


def auto_unfollow_all_followers(self,count=None):
"""
Unfollows everyone
Unfollows everyone that you are following(except those who you have specified not to)
"""
following = self.get_follows_list()

Expand Down

0 comments on commit 65dc75c

Please sign in to comment.