search

barnumbirr / wookie

wookie is a simple, open source, easy-to-use iRC RSS bot written in Python. It was designed to announce new torrent releases in a given iRC channel.
Other
14 stars 9 forks source link

Documentation update needed #15

Open jrogers512 opened 8 years ago

jrogers512 commented 8 years ago

I'd fork and send back with stuff documented, but I can't figure out a couple of things:

  1. 'announce': [''], <- What is this?

  2. 'request': [''], -< This appears to be an array of RSS feeds, would this example be reasonable?

    'request': ['http://domain.to/rss/feed1','http://domain.to/rss/feed2'],

  3. What is the api and blacklist sections for in config.py?
barnumbirr commented 8 years ago

Hi there,

announce and request are indeed an array of RSS feeds. api and blacklistare config settings we're using for our own instance of the bot. One allows us to query an API endpoint, the other allows us to blacklist some entries from the RSS feed.

This was never really supposed to be used by anyone else then us: anyone wanting to use this will need to change to code base quite substantially.

Cheers.

jrogers512 commented 8 years ago

I'm using it rather successfully, just wondering what some of the bits do. I've loaded a list of urls into request, and works ok. I'm not sure what the difference is between announce and request is, but noticed that announce can be empty, but request cannot.

Also, for the bot_owner, what is the format for the owner's name? Is it the nick, the irc mask, or something else? I can't seem to get wookie to respond to private messages.