General purpose Slack-bot with personality
Project description
.. raw:: html
<!--For conversion to rst run the command below from project root-->
.. raw:: html
<!--pandoc --from=markdown --to=rst README.md -o README.rst-->
Setup
=====
Overview
--------
A `slackbot <https://github.com/lins05/slackbot>`__ plugin that acts as
a general purpose Slack bot. Although botty\_mcbotface is not sentient,
it does display a little sense of humor.
Much inspiration drawn from snoonet's
`gonzobot <https://github.com/snoonetIRC/CloudBot>`__ for IRC. The main
build is from lins05's
`slackbot <https://github.com/lins05/slackbot>`__, which
botty\_mcbotface is technically a plugin for (though he himself has a
multitude of plugins as well).
Installation
------------
*For more info on the setup for slackbot (number 2 & 3 below) you can
read up `here <https://github.com/lins05/slackbot>`__*
1. Start a virtualenv in whatever directory you want to run botty, then
cd into the project root and follow the remaining instructions
2. In your new project directory, create a ``slackbot_settings.py``:
::
API_TOKEN = 'your bot API token here'
# Default bot reply when pinged but has no command registered to respond with
DEFAULT_REPLY = "Sorry but I didn't understand you"
# User to send errors to in DM
ERRORS_TO = 'danny'
# Include all plugins like below, otherwise you can specify with multiple list items
PLUGINS = [
'botty_mcbotface.plugins'
]
3. Create a ``run.py`` file, this is the main entry point:
::
#!/usr/bin/env python
from slackbot.bot import Bot
import logging
logging.basicConfig()
def main():
bot = Bot()
bot.run()
if __name__ == "__main__":
main()
4. Run ``pip install botty-mcbotface``
5. Run ``python run.py``:
Contributors
------------
`Danny Hinshaw <https://github.com/DannyHinshaw>`__
License
-------
The MIT License (see `LICENSE <LICENSE>`__)
<!--For conversion to rst run the command below from project root-->
.. raw:: html
<!--pandoc --from=markdown --to=rst README.md -o README.rst-->
Setup
=====
Overview
--------
A `slackbot <https://github.com/lins05/slackbot>`__ plugin that acts as
a general purpose Slack bot. Although botty\_mcbotface is not sentient,
it does display a little sense of humor.
Much inspiration drawn from snoonet's
`gonzobot <https://github.com/snoonetIRC/CloudBot>`__ for IRC. The main
build is from lins05's
`slackbot <https://github.com/lins05/slackbot>`__, which
botty\_mcbotface is technically a plugin for (though he himself has a
multitude of plugins as well).
Installation
------------
*For more info on the setup for slackbot (number 2 & 3 below) you can
read up `here <https://github.com/lins05/slackbot>`__*
1. Start a virtualenv in whatever directory you want to run botty, then
cd into the project root and follow the remaining instructions
2. In your new project directory, create a ``slackbot_settings.py``:
::
API_TOKEN = 'your bot API token here'
# Default bot reply when pinged but has no command registered to respond with
DEFAULT_REPLY = "Sorry but I didn't understand you"
# User to send errors to in DM
ERRORS_TO = 'danny'
# Include all plugins like below, otherwise you can specify with multiple list items
PLUGINS = [
'botty_mcbotface.plugins'
]
3. Create a ``run.py`` file, this is the main entry point:
::
#!/usr/bin/env python
from slackbot.bot import Bot
import logging
logging.basicConfig()
def main():
bot = Bot()
bot.run()
if __name__ == "__main__":
main()
4. Run ``pip install botty-mcbotface``
5. Run ``python run.py``:
Contributors
------------
`Danny Hinshaw <https://github.com/DannyHinshaw>`__
License
-------
The MIT License (see `LICENSE <LICENSE>`__)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for botty_mcbotface-1.2.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 34245b18216925b86c868dda8764144bab24ee1fa5f3114ecd3c434244cfac23 |
|
| MD5 | d7e28c569aab76fa2ee76ebffba63da0 |
|
| BLAKE2b-256 | 3e48885fbdcc0db1d641eb58df1607f113ce669dfb8560d353717141c03aa65f |
