Charlesbot Commands
🔞 ALL INFORMATION CLICK HERE 👈🏻👈🏻👈🏻
Charlesbot Commands
!help
Sends a PM of all the custom commands you have access to.
CharlesBot © 2018 | All rights reserved.
CharlesBot was built (with tender loving care) for the sole purpose of helping models better manage their chat rooms, allowing them to focus on putting on the best show for their members.
TheProgrammer, Creator.
CharlesBot © 2018 | All rights reserved.
!help Sends a PM of all the custom commands you have access to.
!delcom [command] Allows you to remove custom commands from CharlesBot. Also removes the command from the list of automatic ads.
!addcom [command] [response] Allows you to add custom commands to CharlesBot Example: !addcom !videos BUY MY VIDEOS! This creates a new !videos command. From this point, typing !videos will tell CharlesBot to post BUY MY VIDEOS!
CharlesBot was built (with tender loving care) for the sole purpose of helping models better manage their chat rooms, allowing them to focus on putting on the best show for their members.
TheProgrammer, Creator.
CharlesBot © 2018 | All rights reserved.
!clear CharlesBot clears the chat in the event of inappropriate or malicious messages. Only models and CharlesBot helpers have access to this command.
!listhelpers Lets you know what CharlesBot helpers you have in your room.
!delhelper [username] Removes a CharlesBot helper from your room.
!addhelper [username] Adds a CharlesBot helper to your room.
CharlesBot was built (with tender loving care) for the sole purpose of helping models better manage their chat rooms, allowing them to focus on putting on the best show for their members.
TheProgrammer, Creator.
Navigation
index
next |
previous |
charlesbot 0.10.1 documentation »
Docs
Charlesbot Plugin Tutorial
cookiecutter https://github.com/marvinpinto/cookiecutter-charlesbot-plugin.git
full_name [Marvin Pinto]:
email [marvin@pinto.im]:
github_username [marvinpinto]:
project_name [CharlesBOT Hello World]: Hello World example for Charlesbot
repo_name [charlesbot-helloworld]: charlesbot-hello-world
package_name [charlesbot_helloworld]: charlesbot_hello_world
plugin_name [HelloWorld]: HelloWorld
project_short_description [Boilerplate contains all you need to quickly create a CharlesBOT plugin]: Hello World example for Charlesbot
release_date [2015-09-23]: 2016-03-17
year [2015]: 2016
version [0.1.0]: 0.0.1
main :
slackbot_token : 'xoxb-...' # your slackbot token
enabled_plugins :
- 'charlesbot_hello_world.helloworld.HelloWorld'
helloworld :
config_key : 'fake'
2016-03-17 12:33:41,872: INFO [charlesbot.__main__:13] Starting CharlesBOT now!
2016-03-17 12:33:41,876: INFO [charlesbot.base_plugin:15] Initializing the HelloWorld plugin
2016-03-17 12:33:41,945: INFO [charlesbot.base_plugin:15] Initializing the Ping Pong plugin
2016-03-17 12:33:41,947: INFO [charlesbot.base_plugin:15] Initializing the Help! plugin
!command - Does a really neat thing!
!help - This help message
!version - List the running CharlesBOT version
--- a/charlesbot_hello_world/helloworld.py
+++ b/charlesbot_hello_world/helloworld.py
@@ -1,5 +1,7 @@
from charlesbot.base_plugin import BasePlugin
from charlesbot.config import configuration
+from charlesbot.slack.slack_message import SlackMessage
+from charlesbot.util.parse import does_msg_contain_prefix
import asyncio
@@ -21,3 +23,12 @@ class HelloWorld(BasePlugin):
@asyncio.coroutine
def process_message(self, message):
self.log.info("Processing message %s" % message)
+
+ if not type(message) is SlackMessage:
+ return
+
+ if not does_msg_contain_prefix("!hn", message.text):
+ return
+
+ return_msg = "Hi there!"
+ yield from self.slack.send_channel_message(message.channel, return_msg)
--- a/charlesbot_hello_world/helloworld.py
+++ b/charlesbot_hello_world/helloworld.py
@@ -3,6 +3,7 @@ from charlesbot.config import configuration
from charlesbot.slack.slack_message import SlackMessage
from charlesbot.util.parse import does_msg_contain_prefix
import asyncio
+import aiohttp
class HelloWorld(BasePlugin):
@@ -30,5 +31,19 @@ class HelloWorld(BasePlugin):
if not does_msg_contain_prefix("!hn", message.text):
return
- return_msg = "Hi there!"
- yield from self.slack.send_channel_message(message.channel, return_msg)
+ return_msg = yield from self.get_all_hn_top_stories()
+ yield from self.slack.send_channel_message(message.channel, str(return_msg))
+
+ @asyncio.coroutine
+ def get_all_hn_top_stories(self):
+ hn_top_stories_url = "https://hacker-news.firebaseio.com/v0/topstories.json"
+ response = yield from aiohttp.get(hn_top_stories_url)
+ if not response.status == 200:
+ text = yield from response.text()
+ self.log.error("URL: %s" % url)
+ self.log.error("Response status code was %s" % str(response.status))
+ self.log.error(response.headers)
+ self.log.error(text)
+ response.close()
+ return []
+ return (yield from response.json())
[11308160, 11305527, 11308064, ... ]
--- a/charlesbot_hello_world/helloworld.py
+++ b/charlesbot_hello_world/helloworld.py
@@ -31,7 +31,8 @@ class HelloWorld(BasePlugin):
if not does_msg_contain_prefix("!hn", message.text):
return
- return_msg = yield from self.get_all_hn_top_stories()
+ raw_story_ids = yield from self.get_all_hn_top_stories()
+ return_msg = yield from self.print_top_n_hn_stories(5, raw_story_ids)
yield from self.slack.send_channel_message(message.channel, str(return_msg))
@asyncio.coroutine
@@ -47,3 +48,22 @@ class HelloWorld(BasePlugin):
response.close()
return []
return (yield from response.json())
+
+ @asyncio.coroutine
+ def print_top_n_hn_stories(self, number_of_stories, raw_story_ids):
+ return_string = []
+ for story in raw_story_ids[:number_of_stories]:
+ url = "https://hacker-news.firebaseio.com/v0/item/%s.json" % story
+ self.log.info("Now processing story: %s" % url)
+ response = yield from aiohttp.get(url)
+ if not response.status == 200:
+ text = yield from response.text()
+ self.log.error("URL: %s" % url)
+ self.log.error("Response status code was %s" % str(response.status))
+ self.log.error(response.headers)
+ self.log.error(text)
+ response.close()
+ continue
+ json_story = yield from response.json()
+ return_string.append("%s (%s)" % (json_story['title'], json_story['url']))
+ return "\n".join(return_string)
Google Puts Boston Dynamics Up for Sale in Robotics Retreat (http://www.bloomberg.com/news/articles/2016-03-17/google-is-said-to-put-boston-dynamics-robotics-unit-up-for-sale)
A Government Error Just Revealed Snowden Was the Target in the Lavabit Case (http://www.wired.com/2016/03/government-error-just-revealed-snowden-target-lavabit-case/)
Atom 1.6 Released with Pending Pane Items, Async Git and Top and Bottom Bar API (http://blog.atom.io/2016/03/17/atom-1-6-and-1-7-beta.html)
Facebook is the new Excel (http://alexmuir.com/facebook-is-the-new-excel)
The birth of Baghdad was a landmark for world civilisation (http://www.theguardian.com/cities/2016/mar/16/story-cities-day-3-baghdad-iraq-world-civilisation)
--- a/charlesbot_hello_world/helloworld.py
+++ b/charlesbot_hello_world/helloworld.py
@@ -1,6 +1,7 @@
from charlesbot.base_plugin import BasePlugin
from charlesbot.config import configuration
from charlesbot.slack.slack_message import SlackMessage
+from charlesbot.slack.slack_attachment import SlackAttachment
from charlesbot.util.parse import does_msg_contain_prefix
import asyncio
import aiohttp
@@ -32,8 +33,15 @@ class HelloWorld(BasePlugin):
return
raw_story_ids = yield from self.get_all_hn_top_stories()
- return_msg = yield from self.print_top_n_hn_stories(5, raw_story_ids)
- yield from self.slack.send_channel_message(message.channel, str(return_msg))
+ return_attachment = yield from self.print_top_n_hn_stories(5, raw_story_ids)
+ yield from self.slack.api_call(
+ 'chat.postMessage',
+ channel=message.channel,
+ attachments=return_attachment,
+ as_user=False,
+ username="Hacker News",
+ icon_url="https://s3-us-west-2.amazonaws.com/slack-files2/bot_icons/2016-03-18/27749445461_48.png"
+ )
@asyncio.coroutine
def get_all_hn_top_stories(self):
@@ -65,5 +73,8 @@ class HelloWorld(BasePlugin):
response.close()
continue
json_story = yield from response.json()
- return_string.append("%s (%s)" % (json_story['title'], json_story['url']))
- return "\n".join(return_string)
+ return_string.append("<%s|%s>" % (json_story['url'], json_story['title']))
+ formatted_msg = "\n".join(return_string)
+ return SlackAttachment(fallback=formatted_msg,
+ text=formatted_msg,
+ mrkdwn_in=["text"])
--- a/charlesbot_hello_world/helloworld.py
+++ b/charlesbot_hello_world/helloworld.py
@@ -5,6 +5,7 @@ from charlesbot.slack.slack_attachment import SlackAttachment
from charlesbot.util.parse import does_msg_contain_prefix
import asyncio
import aiohttp
+from aiocron import crontab
class HelloWorld(BasePlugin):
@@ -12,6 +13,7 @@ class HelloWorld(BasePlugin):
def __init__(self):
super().__init__("HelloWorld")
self.load_config()
+ self.schedule_timer_message()
def load_config(self): # pragma: no cover
config_dict = configuration.get()
@@ -78,3 +80,35 @@ class HelloWorld(BasePlugin):
return SlackAttachment(fallback=formatted_msg,
text=formatted_msg,
mrkdwn_in=["text"])
+
+ @asyncio.coroutine
+ def get_all_hn_new_stories(self):
+ hn_new_stories_url = "https://hacker-news.firebaseio.com/v0/newstories.json"
+ response = yield from aiohttp.get(hn_new_stories_url)
+ if not response.status == 200:
+ text = yield from response.text()
+ self.log.error("URL: %s" % url)
+ self.log.error("Response status code was %s" % str(response.status))
+ self.log.error(response.headers)
+ self.log.error(text)
+ response.close()
+ return []
+ return (yield from response.json())
+
+ def schedule_timer_message(self):
+ "Print out the top five newly submitted HN stories every minute"
+ timer = crontab('* * * * *', func=self.send_timer_message, start=False)
+ timer.start()
+
+ @asyncio.coroutine
+ def send_timer_message(self):
+ raw_story_ids = yield from self.get_all_hn_new_stories()
+ return_attachment = yield from self.print_top_n_hn_stories(5, raw_story_ids)
+ yield from self.slack.api_call(
+ 'chat.postMessage',
+ channel="#general",
+ attachments=return_attachment,
+ as_user=False,
+ username="Hacker News",
+ icon_url="https://s3-us-west-2.amazonaws.com/slack-files2/bot_icons/2016-03-18/27749445461_48.png"
+ )
--- a/charlesbot_hello_world/helloworld.py
+++ b/charlesbot_hello_world/helloworld.py
@@ -17,7 +17,7 @@ class HelloWorld(BasePlugin):
def load_config(self): # pragma: no cover
config_dict = configuration.get()
- self.token = config_dict['helloworld']['config_key']
+ self.num_articles = config_dict['helloworld']['num_articles']
def get_help_message(self):
help_msg = []
@@ -35,7 +35,7 @@ class HelloWorld(BasePlugin):
return
raw_story_ids = yield from self.get_all_hn_top_stories()
- return_attachment = yield from self.print_top_n_hn_stories(5, raw_story_ids)
+ return_attachment = yield from self.print_top_n_hn_stories(self.num_articles, raw_story_ids)
yield from self.slack.api_call(
'chat.postMessage',
channel=message.channel,
@@ -103,7 +103,7 @@ class HelloWorld(BasePlugin):
@asyncio.coroutine
def send_timer_message(self):
raw_story_ids = yield from self.get_all_hn_new_stories()
- return_attachment = yield from self.print_top_n_hn_stories(5, raw_story_ids)
+ return_attachment = yield from self.print_top_n_hn_stories(self.num_articles, raw_story_ids)
yield from self.slack.api_call(
'chat.postMessage',
channel="#general",
--- a/charlesbot_hello_world/helloworld.py
+++ b/charlesbot_hello_world/helloworld.py
@@ -21,7 +21,7 @@ class HelloWorld(BasePlugin):
def get_help_message(self):
help_msg = []
- help_msg.append("!command - Does a really neat thing!")
+ help_msg.append("!hn - Print out the top %s stories currently trending on Hacker News" % self.num_articles)
return "\n".join(help_msg)
@asyncio.coroutine
!help - This help message
!hn - Print out the top 10 stories currently trending on Hacker News
!version - List the running CharlesBOT version
Navigation
index
next |
previous |
charlesbot 0.10.1 documentation »
© Copyright 2016, Marvin Pinto. Created using Sphinx .
This tutorial will cover the basics of how to build a Charlesbot plugin. You do
not need to know a whole lot about Python or Slack to follow along, but it
might help if you do.
It’s been structured to make it easy for folks to follow along so if you see
any room for improvement, I would love to hear from you .
The full package for this hello-world plugin is available at
marvinpinto/charlesbot-hello-world . For folks following along, each step
here links to a corresponding commit in that repository which should hopefully
make things easier.
Let’s start with some high level goals. Our ficticious plugin should be able to
do the following:
The purpose of this is to demonstrate the mechanism Charlesbot uses to respond
to human-initated events, run periodic jobs, and read program configuration.
The building blocks of a chatbot if you will!
Here’s the basics you’ll need to get started:
You have the option of using the pre-built vagrant environment too, if
you wish. The Vagrantfile is available in the
charlesbot-hello-world repository.
Thanks to the wonderful work done in the cookiecutter project, starting a
new Charlesbot plugin is as simple as using the cookiecutter template
already setup! Here’s how to use it:
Cookie Cutter will ask you a few questions about the plugin:
And now you now have a very basic Charlesbot plugin! You can verify that the
boilerplate tests work by running make test inside the
charlesbot-hello-world directory.
Now that we have the basic plugin setup, let’s hook it up into slack and start
playing with it.
Create a development.yaml file in the root of the plugin directory with the
following contents:
What that tells Charlesbot to do is to use the specified slackbot token and
load the charlesbot-helloworld plugin, in addition to the default plugins.
Now start up your local Charlesbot instance using make run .
You should see output that looks something like:
You can verify that Charlesbot is actually running with your loaded plugin by
messaging your bot user with !help :
The help message for !command orgininates in the charlesbot-helloworld
plugin.
A chatbot is not very useful unless it’s able to read and process human input.
So update the imports and modify the process_message function in
charlesbot_hello_world/helloworld.py as follows:
What we’re doing here is using the SlackMessage object and the
does_msg_contain_prefix helper to determine if a !hn message was
entered in chat. Then the send_channel_message helper prints out Hi
there! in chat. Try it out!
Now that we have a mechanism in place to read human input, let’s modify the
!hn command so that instead of responding with Hi there! , it prints out
the story IDs of all the trending news stories on Hacker News.
Modify the process_message function and add the get_all_hn_top_stories
function:
As you will see from the output, that prints something along the lines of:
Which is not very interesting. We’ll fix that!
Let’s add a function to refine the list to the top five Hacker News stories and
also print out the relevant details.
Update the process_message function and add the print_top_n_hn_stories
function:
Slack has some very nice message formatting features so let’s use the
api_call helper to invoke this in Charlesbot.
Import the SlackAttachment helper and modify helloworld.py as follows:
The next thing we’re going to cover here is how to use the Charlesbot helpers
to run periodic jobs. A good example of this is in the built-in ping-pong
function.
We’re going to implement a timer that prints out the top five newly submitted
Hacker News stories.
Up next, let’s make the number of Hacker News articles retrieved a
configurable value.
Modify your development.yaml file so that the num_articles key is
present:
Then update helloworld.py to read and utilize the num_articles key:
And finally, now that we have a working !hn plugin, let’s update the help
output accordingly.
Here are some final thoughts to help you along your chatbot journey:
Sexy Mature Woman In Stocking
Gangbang 50 Men
Rick Morty Porn