ChCh/CloudBot
Archived
11
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Create gh-pages branch via GitHub

Browse source
This commit is contained in:
Luke Rogers 2013-07-01 09:20:50 -07:00
commit 78d0874e37
5 changed files with 490 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

148
index.html Normal file
View file

@ -0,0 +1,148 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>CloudBot by ClouDev</title>
<link rel="stylesheet" href="stylesheets/styles.css">
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1>CloudBot</h1>
<p>The easy to use, open source Python IRC Bot!</p>
<p class="view"><a href="https://github.com/ClouDev/CloudBot">View the Project on GitHub <small>ClouDev/CloudBot</small></a></p>
<ul>
<li><a href="https://github.com/ClouDev/CloudBot/zipball/master">Download <strong>ZIP File</strong></a></li>
<li><a href="https://github.com/ClouDev/CloudBot/tarball/master">Download <strong>TAR Ball</strong></a></li>
<li><a href="https://github.com/ClouDev/CloudBot">View On <strong>GitHub</strong></a></li>
</ul>
</header>
<section>
<h1>
<a name="cloudbotdev" class="anchor" href="#cloudbotdev"><span class="octicon octicon-link"></span></a>CloudBot/DEV</h1>
<h2>
<a name="about" class="anchor" href="#about"><span class="octicon octicon-link"></span></a>About</h2>
<p>CloudBot is a Python IRC bot based on <a href="http://git.io/skybot">Skybot</a> by <a href="http://git.io/rmmh">rmmh</a>.</p>
<h2>
<a name="getting-and-using-cloudbot" class="anchor" href="#getting-and-using-cloudbot"><span class="octicon octicon-link"></span></a>Getting and using CloudBot</h2>
<h3>
<a name="download" class="anchor" href="#download"><span class="octicon octicon-link"></span></a>Download</h3>
<p>Get CloudBot at <a href="https://github.com/ClouDev/CloudBot/zipball/develop" title="Get CloudBot from Github!">https://github.com/ClouDev/CloudBot/zipball/develop</a>.</p>
<p>Unzip the resulting file, and continue to read this document.</p>
<h3>
<a name="install" class="anchor" href="#install"><span class="octicon octicon-link"></span></a>Install</h3>
<p>Before you can run the bot, you need to install a few Python dependencies.
You are <em>required</em> to install <code>lxml</code>, and <code>Enchant</code> and <code>PyDNS</code> are required for some plugins to function.</p>
<p>These can be installed with <code>pip</code> (The Python package manager):</p>
<pre><code>[sudo] pip install -r requirements.txt
</code></pre>
<h4>
<a name="how-to-install-pip" class="anchor" href="#how-to-install-pip"><span class="octicon octicon-link"></span></a>How to install <code>pip</code>
</h4>
<pre><code>curl -O http://python-distribute.org/distribute_setup.py # or download with your browser on windows
python distribute_setup.py
easy_install pip
</code></pre>
<p>If you are unable to use pip, there are Windows installers for LXML available for <a href="https://pypi.python.org/packages/2.7/l/lxml/lxml-2.3.win-amd64-py2.7.exe">64 bit</a> and <a href="https://pypi.python.org/packages/2.7/l/lxml/lxml-2.3.win32-py2.7.exe">32 bit</a> versions of Python.</p>
<h3>
<a name="run" class="anchor" href="#run"><span class="octicon octicon-link"></span></a>Run</h3>
<p>Once you have installed the required dependencies, you can run the bot! Make sure you are in the correct folder and run the following command:</p>
<p><code>python bot.py</code></p>
<p>The first time you run the bot it will generate the config file. The next time you run it, it will start normally.</p>
<p>On Windows you can usually just double-click <code>bot.py</code> to start the bot, as long as you have Python installed correctly.</p>
<h2>
<a name="getting-help-with-cloudbot" class="anchor" href="#getting-help-with-cloudbot"><span class="octicon octicon-link"></span></a>Getting help with CloudBot</h2>
<h3>
<a name="documentation" class="anchor" href="#documentation"><span class="octicon octicon-link"></span></a>Documentation</h3>
<p>To configure your CloudBot, visit the <a href="http://git.io/cloudbotircconfig">Config Wiki Page</a>.</p>
<p>To write your own plugins, visit the <a href="http://git.io/cloudbotircplugins">Plugin Wiki Page</a>.</p>
<p>More at the <a href="http://git.io/cloudbotircwiki">Wiki Main Page</a>.</p>
<h3>
<a name="support" class="anchor" href="#support"><span class="octicon octicon-link"></span></a>Support</h3>
<p>The developers reside in <a>#CloudBot</a> on <a href="http://esper.net">EsperNet</a> and would be glad to help you.</p>
<p>If you think you have found a bug/have a idea/suggestion, please <strong>open a issue</strong> here on Github.</p>
<h3>
<a name="requirements" class="anchor" href="#requirements"><span class="octicon octicon-link"></span></a>Requirements</h3>
<p>CloudBot runs on <strong>Python</strong> <em>2.7.x</em>. It is developed on <strong>Ubuntu</strong> <em>12.04</em> with <strong>Python</strong> <em>2.7.3</em>.</p>
<p>It <strong>requires the Python module</strong> lXML.
The module <code>Enchant</code> is needed for the spellcheck plugin.
The module <code>PyDNS</code> is needed for SRV record lookup in the mctools plugin.</p>
<p><strong>Windows</strong> users: Windows compatibility some plugins is <strong>broken</strong> (such as ping), but we do intend to add it. Eventually.</p>
<h2>
<a name="example-cloudbots" class="anchor" href="#example-cloudbots"><span class="octicon octicon-link"></span></a>Example CloudBots</h2>
<p>You can find a number of example bots in <a title="Connect via IRC to #CloudBot on irc.esper.net">#CloudBot</a>.</p>
<h2>
<a name="license" class="anchor" href="#license"><span class="octicon octicon-link"></span></a>License</h2>
<p>CloudBot is <strong>licensed</strong> under the <strong>GPL v3</strong> license. The terms are as follows.</p>
<pre><code>CloudBot/DEV
Copyright © 2011-2013 Luke Rogers / ClouDev - &lt;[cloudev.github.com](http://cloudev.github.com)&gt;
CloudBot is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CloudBot is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CloudBot. If not, see &lt;http://www.gnu.org/licenses/&gt;.
</code></pre>
</section>
<footer>
<p>This project is maintained by <a href="https://github.com/ClouDev">ClouDev</a></p>
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
</footer>
</div>
<script src="javascripts/scale.fix.js"></script>
</body>
</html>

17
javascripts/scale.fix.js Normal file
View file

@ -0,0 +1,17 @@
var metas = document.getElementsByTagName('meta');
var i;
if (navigator.userAgent.match(/iPhone/i)) {
for (i=0; i<metas.length; i++) {
if (metas[i].name == "viewport") {
metas[i].content = "width=device-width, minimum-scale=1.0, maximum-scale=1.0";
}
}
document.addEventListener("gesturestart", gestureStart, false);
}
function gestureStart() {
for (i=0; i<metas.length; i++) {
if (metas[i].name == "viewport") {
metas[i].content = "width=device-width, minimum-scale=0.25, maximum-scale=1.6";
}
}
}

1
params.json Normal file
View file

@ -0,0 +1 @@
{"name":"CloudBot","tagline":"The easy to use, open source Python IRC Bot!","body":"# CloudBot/DEV\r\n\r\n## About\r\n\r\nCloudBot is a Python IRC bot based on [Skybot](http://git.io/skybot) by [rmmh](http://git.io/rmmh).\r\n\r\n## Getting and using CloudBot\r\n\r\n### Download\r\n\r\nGet CloudBot at [https://github.com/ClouDev/CloudBot/zipball/develop](https://github.com/ClouDev/CloudBot/zipball/develop \"Get CloudBot from Github!\").\r\n\r\nUnzip the resulting file, and continue to read this document.\r\n\r\n### Install\r\n \r\nBefore you can run the bot, you need to install a few Python dependencies.\r\nYou are *required* to install `lxml`, and `Enchant` and `PyDNS` are required for some plugins to function.\r\n\r\n\r\nThese can be installed with `pip` (The Python package manager):\r\n\r\n [sudo] pip install -r requirements.txt\r\n\r\n#### How to install `pip`\r\n\r\n curl -O http://python-distribute.org/distribute_setup.py # or download with your browser on windows\r\n python distribute_setup.py\r\n easy_install pip\r\n \r\nIf you are unable to use pip, there are Windows installers for LXML available for [64 bit](https://pypi.python.org/packages/2.7/l/lxml/lxml-2.3.win-amd64-py2.7.exe) and [32 bit](https://pypi.python.org/packages/2.7/l/lxml/lxml-2.3.win32-py2.7.exe) versions of Python.\r\n\r\n### Run\r\n\r\nOnce you have installed the required dependencies, you can run the bot! Make sure you are in the correct folder and run the following command:\r\n\r\n`python bot.py`\r\n\r\nThe first time you run the bot it will generate the config file. The next time you run it, it will start normally.\r\n\r\nOn Windows you can usually just double-click `bot.py` to start the bot, as long as you have Python installed correctly.\r\n\r\n## Getting help with CloudBot\r\n\r\n### Documentation\r\n\r\nTo configure your CloudBot, visit the [Config Wiki Page](http://git.io/cloudbotircconfig).\r\n\r\nTo write your own plugins, visit the [Plugin Wiki Page](http://git.io/cloudbotircplugins).\r\n\r\nMore at the [Wiki Main Page](http://git.io/cloudbotircwiki).\r\n\r\n### Support\r\n\r\nThe developers reside in [#CloudBot](irc://irc.esper.net/cloudbot) on [EsperNet](http://esper.net) and would be glad to help you.\r\n\r\nIf you think you have found a bug/have a idea/suggestion, please **open a issue** here on Github.\r\n\r\n### Requirements\r\n\r\nCloudBot runs on **Python** *2.7.x*. It is developed on **Ubuntu** *12.04* with **Python** *2.7.3*.\r\n\r\nIt **requires the Python module** lXML.\r\nThe module `Enchant` is needed for the spellcheck plugin.\r\nThe module `PyDNS` is needed for SRV record lookup in the mctools plugin.\r\n\r\n**Windows** users: Windows compatibility some plugins is **broken** (such as ping), but we do intend to add it. Eventually.\r\n\r\n## Example CloudBots\r\n\r\nYou can find a number of example bots in [#CloudBot](irc://irc.esper.net/cloudbot \"Connect via IRC to #CloudBot on irc.esper.net\").\r\n\r\n## License\r\n\r\nCloudBot is **licensed** under the **GPL v3** license. The terms are as follows.\r\n\r\n CloudBot/DEV\r\n\r\n Copyright © 2011-2013 Luke Rogers / ClouDev - <[cloudev.github.com](http://cloudev.github.com)>\r\n\r\n CloudBot is free software: you can redistribute it and/or modify\r\n it under the terms of the GNU General Public License as published by\r\n the Free Software Foundation, either version 3 of the License, or\r\n (at your option) any later version.\r\n\r\n CloudBot is distributed in the hope that it will be useful,\r\n but WITHOUT ANY WARRANTY; without even the implied warranty of\r\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r\n GNU General Public License for more details.\r\n\r\n You should have received a copy of the GNU General Public License\r\n along with CloudBot. If not, see <http://www.gnu.org/licenses/>.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}

69
stylesheets/pygment_trac.css Normal file
View file

@ -0,0 +1,69 @@
.highlight { background: #ffffff; }
.highlight .c { color: #999988; font-style: italic } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { font-weight: bold } /* Keyword */
.highlight .o { font-weight: bold } /* Operator */
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #999999 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { font-weight: bold } /* Keyword.Constant */
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
.highlight .kn { font-weight: bold } /* Keyword.Namespace */
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #009999 } /* Literal.Number */
.highlight .s { color: #d14 } /* Literal.String */
.highlight .na { color: #008080 } /* Name.Attribute */
.highlight .nb { color: #0086B3 } /* Name.Builtin */
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
.highlight .no { color: #008080 } /* Name.Constant */
.highlight .ni { color: #800080 } /* Name.Entity */
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
.highlight .nn { color: #555555 } /* Name.Namespace */
.highlight .nt { color: #000080 } /* Name.Tag */
.highlight .nv { color: #008080 } /* Name.Variable */
.highlight .ow { font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #009999 } /* Literal.Number.Float */
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
.highlight .sb { color: #d14 } /* Literal.String.Backtick */
.highlight .sc { color: #d14 } /* Literal.String.Char */
.highlight .sd { color: #d14 } /* Literal.String.Doc */
.highlight .s2 { color: #d14 } /* Literal.String.Double */
.highlight .se { color: #d14 } /* Literal.String.Escape */
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
.highlight .si { color: #d14 } /* Literal.String.Interpol */
.highlight .sx { color: #d14 } /* Literal.String.Other */
.highlight .sr { color: #009926 } /* Literal.String.Regex */
.highlight .s1 { color: #d14 } /* Literal.String.Single */
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #008080 } /* Name.Variable.Class */
.highlight .vg { color: #008080 } /* Name.Variable.Global */
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
.type-csharp .highlight .k { color: #0000FF }
.type-csharp .highlight .kt { color: #0000FF }
.type-csharp .highlight .nf { color: #000000; font-weight: normal }
.type-csharp .highlight .nc { color: #2B91AF }
.type-csharp .highlight .nn { color: #000000 }
.type-csharp .highlight .s { color: #A31515 }
.type-csharp .highlight .sc { color: #A31515 }

255
stylesheets/styles.css Normal file
View file

@ -0,0 +1,255 @@
@import url(https://fonts.googleapis.com/css?family=Lato:300italic,700italic,300,700);
body {
padding:50px;
font:14px/1.5 Lato, "Helvetica Neue", Helvetica, Arial, sans-serif;
color:#777;
font-weight:300;
}
h1, h2, h3, h4, h5, h6 {
color:#222;
margin:0 0 20px;
}
p, ul, ol, table, pre, dl {
margin:0 0 20px;
}
h1, h2, h3 {
line-height:1.1;
}
h1 {
font-size:28px;
}
h2 {
color:#393939;
}
h3, h4, h5, h6 {
color:#494949;
}
a {
color:#39c;
font-weight:400;
text-decoration:none;
}
a small {
font-size:11px;
color:#777;
margin-top:-0.6em;
display:block;
}
.wrapper {
width:860px;
margin:0 auto;
}
blockquote {
border-left:1px solid #e5e5e5;
margin:0;
padding:0 0 0 20px;
font-style:italic;
}
code, pre {
font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
color:#333;
font-size:12px;
}
pre {
padding:8px 15px;
background: #f8f8f8;
border-radius:5px;
border:1px solid #e5e5e5;
overflow-x: auto;
}
table {
width:100%;
border-collapse:collapse;
}
th, td {
text-align:left;
padding:5px 10px;
border-bottom:1px solid #e5e5e5;
}
dt {
color:#444;
font-weight:700;
}
th {
color:#444;
}
img {
max-width:100%;
}
header {
width:270px;
float:left;
position:fixed;
}
header ul {
list-style:none;
height:40px;
padding:0;
background: #eee;
background: -moz-linear-gradient(top, #f8f8f8 0%, #dddddd 100%);
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#f8f8f8), color-stop(100%,#dddddd));
background: -webkit-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
background: -o-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
background: -ms-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
background: linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
border-radius:5px;
border:1px solid #d2d2d2;
box-shadow:inset #fff 0 1px 0, inset rgba(0,0,0,0.03) 0 -1px 0;
width:270px;
}
header li {
width:89px;
float:left;
border-right:1px solid #d2d2d2;
height:40px;
}
header ul a {
line-height:1;
font-size:11px;
color:#999;
display:block;
text-align:center;
padding-top:6px;
height:40px;
}
strong {
color:#222;
font-weight:700;
}
header ul li + li {
width:88px;
border-left:1px solid #fff;
}
header ul li + li + li {
border-right:none;
width:89px;
}
header ul a strong {
font-size:14px;
display:block;
color:#222;
}
section {
width:500px;
float:right;
padding-bottom:50px;
}
small {
font-size:11px;
}
hr {
border:0;
background:#e5e5e5;
height:1px;
margin:0 0 20px;
}
footer {
width:270px;
float:left;
position:fixed;
bottom:50px;
}
@media print, screen and (max-width: 960px) {
div.wrapper {
width:auto;
margin:0;
}
header, section, footer {
float:none;
position:static;
width:auto;
}
header {
padding-right:320px;
}
section {
border:1px solid #e5e5e5;
border-width:1px 0;
padding:20px 0;
margin:0 0 20px;
}
header a small {
display:inline;
}
header ul {
position:absolute;
right:50px;
top:52px;
}
}
@media print, screen and (max-width: 720px) {
body {
word-wrap:break-word;
}
header {
padding:0;
}
header ul, header p.view {
position:static;
}
pre, code {
word-wrap:normal;
}
}
@media print, screen and (max-width: 480px) {
body {
padding:15px;
}
header ul {
display:none;
}
}
@media print {
body {
padding:0.4in;
font-size:12pt;
color:#444;
}
}