rainbowbismuth / euphoria-py

An asyncio based euphoria.io bot library for Python 3.5

euphoria-py v0.7

An asyncio based euphoria.io bot library and framework for Python 3.5 and newer, ONLY. Make sure you are using the right version of pip and the python interpreter.

API is expected to undergo major additions currently, and the documentation isn't all there yet.

Documentation

Installation

To install the dependencies needed to run euphoria-py, install everything in requirements.txt

pip install -r requirements.txt

Extras

If using the euphoria.services.reddit_notify service, you must install The Pythonic Reddit API Wrapper (PRAW) as well.

pip install praw

Configuration

Edit bot.yml

bot:
  room: room-on-euphoria.io
  # The passcode option can be deleted for a public room
  passcode: password-to-private-room
  nick: bot-nickname
  services:
    # Gives you access to commands like !ping @botname, !kill @botname and !uptime @botname
    botrulez: euphoria.services.botrulez
    # Lets the bot send you reminders later, like !remind 15m take out the trash
    reminder: euphoria.services.reminder
    # Some services might take an extended set of options like reddit_notify
    reddit_notify:
      module: euphoria.services.reddit_notify
      reddit_agent: euphoria-py utility that notifies about new reddit posts
      # A list of subreddits to look for new posts in
      subreddits: [pics, programming, funny]
      # If threading is true then each new post goes in a thread specific to a particular subreddit instead of top-level
      threading: True
      # Customize the message the bot makes when there's a new post. Not all post elements used below have to be used
      post_format: "{short_link} New post to {subreddit} by {author}: {title}"
      # How many hours until a new per-subreddit thread is created
      hours_per_thread: 12

The bog logs information to the console and to a rotating log file by default, you can edit the configuration in logging.yml (It uses the standard python logging framework, see the official documentation)

Running

From this directory run:

python -m euphoria.bot

euphoria-py's Issues

Investigate what happens when e.g. laptop is closed and re-opened later.

At the moment it neither reconnects or shutdowns. I think I might have an idea why this happens but I should write a test for it.

Bot sometimes doesn't try to auth or set nick.

The issue seems to be that since I start both the Client and the NickAndAuth state machine at the same time, sometimes NickAndAuth doesn't start before the Client, and will never see the HelloEvent or BounceEvent.

Fix is to rethink initialization of these two components.

reddit_notify should stick replies in a collapsable stack w/o human intervention

[cammiebutt] this isn't trivial, but
[cammiebutt] have the option to put all new posts without human messages in between under one root level message
[cammiebutt] so that someone can collapse all of them and have human stuffs closer together instead of a page of bot stuff during the night
[♐] i don't think that would be too hard
[♐] but that totally makes sense
[♐] also your feature request wouldn't work with maimai around >_>
[cammiebutt] why?
[♐] becayse maimai comments on every message
[cammiebutt] mhm
[cammiebutt] so ignore direct replies
[cammiebutt] I don't mind being able to collapse something if all we've talked about is the rattie things
[cammiebutt] or ignore bots
[cammiebutt] their user ID is sent iirc
[cammiebutt] yeah
[cammiebutt] look for "bot:" at the beginning of packet["data"]["sender"]["id"]
[♐] ohhh really? ok

Make sure all the current services are using linked tasks instead of asyncio.ensure_future

Should take like 2 seconds just have to remember to do it. euphoria.services.reminder doesn't atm.

Every bot needs its own quote_db file

Otherwise two different bots could be trying to use the same shelf and I'm not entirely sure what would happen there.

Ctrl-C doesn't stop the Bot cleanly

And it really really should, especially when the default behavior is to retry services or restarting the bot as a whole.

Rewrite examples

There should be examples for using the euphoria.Client class by itself, rather then the full framework. They should be written well and automatically tested.

Add command line options to euphoria.bot and euphoria.borg

Like a "-config config_filename.yml" instead of it finding just a completely hardcoded bot.yml or borg.yml

Bot should take a config for multiple rooms from one file

A user should be able to run a bot in multiple rooms with different configurations for each room. The configuration should be taken from one file.

rainbowbismuth, I'm happy to write this after I read over your code. If you'd like to do it, though, please feel free!

Add in some cProfile support

It should be as easy as setting like a single config option (or maybe a command line switch?)

Bot should be able to code reload services.

Make it faster to iterate without having to restart the entire bot.

Fix import stuff

Do this sort of thing: https://github.com/python/asyncio/blob/master/asyncio/__init__.py